Get stage sets for the firm

Returns a list of stage sets for the firm.

GET /stagesets

Get stage sets for the firm

cURL

curl --request GET \
  --url https://api.smokeball.com/stagesets \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

200

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "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": "GET"
          },
          "id": "45b94df1-1657-48b0-ae81-583b42ed52d6",
          "versionId": "09d1f360-b810-4a63-acaa-5ed81a551f06",
          "name": "Review contract",
          "isDeleted": true,
          "lastUpdated": 637847425252027400
        }
      ],
      "lastUpdated": 637847425252027400
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  }
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Query Parameters

Offset · integer<int32>

Required range: 0 <= x <= 2147483647

Limit · integer<int32>

Required range: 1 <= x <= 500

UpdatedSince · integer<int64>

Returns items updated since a specified time (.net ticks representation of the UTC datetime).

LastUpdated · string<date-time>

Deprecated, use updatedSince Returns items updated since a specified time.

Response

200 - application/json

When request is successful. Returns a paged collection of 'StageSet' objects.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object

Show child attributes

value · object[] | null

Show child attributes

offset · integer<int32> | null

limit · integer<int32> | null

size · integer<int64>

first · object

Show child attributes

previous · object

Show child attributes

next · object

Show child attributes

last · object

Show child attributes