Skip to main content
GET
/
stagesets
/
{stageSetId}
/
stages
/
{id}
Get a stage on a stage set
curl --request GET \
  --url https://api.smokeball.com/stagesets/{stageSetId}/stages/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "45b94df1-1657-48b0-ae81-583b42ed52d6",
  "versionId": "09d1f360-b810-4a63-acaa-5ed81a551f06",
  "name": "Review contract",
  "isDeleted": true,
  "lastUpdated": 637847425252027400
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
stageSetId
string<uuid>
required
​
id
string<uuid>
required

Response

When request is successful. Returns a 'Stage' object.

Contains information of a stage in a stage set.

​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
id
string | null

Unique identifier of the stage.

Example:

"45b94df1-1657-48b0-ae81-583b42ed52d6"

​
versionId
string | null

Version id of the record.

Example:

"09d1f360-b810-4a63-acaa-5ed81a551f06"

​
name
string | null

Name of the stage.

Example:

"Review contract"

​
isDeleted
boolean

True when the stage is deleted.

Example:

true

​
lastUpdated
integer<int64>

Timestamp when the stage was last updated.

Example:

637847425252027400