GET
/
matters
/
{matterId}
/
stages
Get a matter stage information
curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/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"
  },
  "versionId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
  "matter": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "stageSet": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "stage": {
    "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

​
matterId
string<uuid>
required

Response

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

Contains the current stage of the matter.

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

Version id of the record.

Example:

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

​
matter
object

Matter in which this mapping is associated to.

​
stageSet
object

Current stage set of the matter.

​
stage
object

Current stage of the matter. Contains information of a stage in a stage set.

​
lastUpdated
integer

Timestamp when the matter stage was last updated.

Example:

637847425252027400