Get contracts

GET 
/api/v2/Contracts

Get contracts

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

Namestringnullablerequired

Codestringnullable

Customerguidnullable

ResponsiblePersonguidnullable

Descriptionstringnullable

StartDatedatenullable

EndDatedatenullable

BillableBillableFlags (string)

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

Notestringnullable

CustomFieldsobjectnullable

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

ExternalKeystringnullable

Statesstring[]nullable

ContactPersonstringnullable

Possible values: <= 50 characters

ContactPhonestringnullable

Possible values: <= 30 characters

ContactEmailstringnullable

Possible values: <= 65 characters

CompletionDatedate-timenullable

Branchguidnullable

]

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

400

Error

application/json

Schema

Schema

Error

object

required

Codestringnullable

Messagestringnullable

Example (from schema)

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