Get subcontracts

GET 
/api/v2/Contracts/Subcontracts

Get subcontracts

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.

contractKey string

Contract Guid or ExternalKey

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

Namestringnullablerequired

Codestringnullable

Contractguid

Descriptionstringnullable

EndDatedatenullable

BillableBillableFlags (string)

Possible values: [None, Billable, ChangeAllowed, BillableChangeAllowed]

Notestringnullable

CustomFieldsobjectnullable

Example: {"MyCustomField":"value","MyNestedObject":{"MyNestedProperty":"value"}}

ExternalKeystringnullable

Statesstring[]nullable

ResponsiblePersonguidnullable

CompletionDatedate-timenullable

]

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",
      "Code": "string",
      "Contract": "string",
      "Description": "string",
      "EndDate": "2024-07-29",
      "Billable": "None",
      "Note": "string",
      "CustomFields": {
        "MyCustomField": "value",
        "MyNestedObject": {
          "MyNestedProperty": "value"
        }
      },
      "ExternalKey": "string",
      "States": [
        "string"
      ],
      "ResponsiblePerson": "string",
      "CompletionDate": "2024-07-29T15:51:28.071Z"
    }
  ]
}

400

Error

application/json

Schema

Schema

Error

object

required

Codestringnullable

Messagestringnullable

Example (from schema)

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