GET
/
stagesets
/
{id}
Get a stage set
curl --request GET \
  --url https://api.smokeball.com/stagesets/{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": "6ccc033d-67c9-4090-8705-3aff0c5a8cfb",
  "versionId": "499244ff-651f-4f66-b618-9defde27c281",
  "name": "Review contract",
  "isDeleted": true,
  "stages": [
    {
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "id": "45b94df1-1657-48b0-ae81-583b42ed52d6",
      "versionId": "09d1f360-b810-4a63-acaa-5ed81a551f06",
      "name": "Review contract",
      "isDeleted": true,
      "lastUpdated": 637847425252027400
    }
  ],
  "lastUpdated": 637847425252027400
}

Authorizations

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

Path Parameters

​
id
string
required

Response

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

Contains the stage set and stages information.

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

Unique identifier of the stage set.

Example:

"6ccc033d-67c9-4090-8705-3aff0c5a8cfb"

​
versionId
string | null

Version id of the record.

Example:

"499244ff-651f-4f66-b618-9defde27c281"

​
name
string | null

Name of the stage set.

Example:

"Review contract"

​
isDeleted
boolean

True when the stage set is deleted.

Example:

true

​
stages
object[] | null

Stages of the stage set.

​
lastUpdated
integer

Timestamp when the stage set was last updated.

Example:

637847425252027400