Get contracts states

GET 
/api/v2/Contracts/States

Get contracts states

Request

Query Parameters

ContinuationToken string

Token is needed, unless all records have been returned in previous request. Do not forget to pass also all other parameters.

Responses

200

Success

application/json

Schema

Schema

ContinuationTokenstringnullable

Items

object[]

nullable

Array [

Guidguid

Revisionint64

PersonCreatedguidnullable

PersonChangedguidnullable

TimestampCreateddate-timenullable

Example: 2025-02-24T10:14:00Z

TimestampChangeddate-timenullable

Example: 2025-02-24T10:14:00Z

Namestringnullable

Possible values: <= 100 characters

DisplayNamestringnullable

Possible values: <= 100 characters

VisibilityContractStateVisibility (string)

Possible values: [Contracts, Subcontracts, All]

Colorstringnullable

Possible values: <= 7 characters

SortOrderinteger

ExternalKeystringnullable

]

Example (from schema)

{
  "ContinuationToken": "string",
  "Items": [
    {
      "Guid": "string",
      "Revision": 0,
      "PersonCreated": "string",
      "PersonChanged": "string",
      "TimestampCreated": "2025-02-24T10:14:00Z",
      "TimestampChanged": "2025-02-24T10:14:00Z",
      "Name": "string",
      "DisplayName": "string",
      "Visibility": "Contracts",
      "Color": "string",
      "SortOrder": 0,
      "ExternalKey": "string"
    }
  ]
}

400

Error

application/json

Schema

Schema

Error

object

required

Codestringnullable

Messagestringnullable

Example (from schema)

{
  "Error": {
    "Code": "string",
    "Message": "string"
  }
}