Get stage to matter mappings in the firm

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

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "versionId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
      "matter": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "stageSet": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "stage": {
        "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"
  }
}

GET

stages

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

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "versionId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
      "matter": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "stageSet": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "stage": {
        "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 'MatterStage' objects.

string | null

href

string | null

relation

string | null

method

string | null

default:GET

self

object

Show child attributes

self.id

string | null

self.href

string | null

self.relation

string | null

self.method

string | null

default:GET

value

object[] | null

Show child attributes

value.id

string | null

value.href

string | null

value.relation

string | null

value.method

string | null

default:GET

value.self

object

Show child attributes

value.self.id

string | null

value.self.href

string | null

value.self.relation

string | null

value.self.method

string | null

default:GET

value.versionId

string | null

Version id of the record.

Example:

"da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262"

value.matter

object

Matter in which this mapping is associated to.

Show child attributes

value.matter.id

string | null

value.matter.href

string | null

value.matter.relation

string | null

value.matter.method

string | null

default:GET

value.stageSet

object

Current stage set of the matter.

Show child attributes

value.stageSet.id

string | null

value.stageSet.href

string | null

value.stageSet.relation

string | null

value.stageSet.method

string | null

default:GET

value.stage

object

Current stage of the matter.

Show child attributes

value.stage.href

string | null

value.stage.relation

string | null

value.stage.method

string | null

default:GET

value.stage.self

object

Show child attributes

value.stage.self.id

string | null

value.stage.self.href

string | null

value.stage.self.relation

string | null

value.stage.self.method

string | null

default:GET

value.stage.id

string | null

Unique identifier of the stage.

Example:

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

value.stage.versionId

string | null

Version id of the record.

Example:

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

value.stage.name

string | null

Name of the stage.

Example:

"Review contract"

value.stage.isDeleted

boolean

True when the stage is deleted.

Example:

true

value.stage.lastUpdated

integer<int64>

Timestamp when the stage was last updated.

Example:

637847425252027400

value.lastUpdated

integer<int64>

Timestamp when the matter stage was last updated.

Example:

637847425252027400

offset

integer<int32> | null

limit

integer<int32> | null

size

integer<int64>

first

object

Show child attributes

first.id

string | null

first.href

string | null

first.relation

string | null

first.method

string | null

default:GET

object

Show child attributes

previous.id

string | null

previous.href

string | null

previous.relation

string | null

previous.method

string | null

default:GET

object

Show child attributes

next.id

string | null

next.href

string | null

next.relation

string | null

next.method

string | null

default:GET

last

object

Show child attributes

last.id

string | null

last.href

string | null

last.relation

string | null

last.method

string | null

default:GET

Deletes a firm staff member Get a matter stage information

⌘I

Documentation

Tutorials

APIs

Get stage to matter mappings in the firm

Authorizations

Query Parameters

Response