Get Contract State

GET 
/api/v2/Contracts/States/:key

Get Contract State

Request

Path Parameters

key stringrequired

Guid or ExternalKey

Responses

200

Success

application/json

Schema

Schema

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)

{
  "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"
}

404

Not found

application/json

Schema

Schema

Guidguid
Revisionint64
PersonCreatedguidnullable
PersonChangedguidnullable
TimestampCreateddate-timenullable
Example: 2025-02-24T10:14:00Z
TimestampChangeddate-timenullable
Example: 2025-02-24T10:14:00Z
Namestringnullablerequired
Codestringnullable

Type

object

oneOf

ActivityType

string

Possible values: [Work, Absence, Break]

Defaultboolean

TimeEntry

object

oneOf

ActivityTypeTimeEntry

string

Possible values: [Optional, TotalTime, FromTo]

Inactiveboolean
Movementboolean
Iconstringnullable
ExternalKeystringnullable

Example (from schema)

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2025-02-24T10:14:00Z",
  "TimestampChanged": "2025-02-24T10:14:00Z",
  "Name": "string",
  "Code": "string",
  "Type": "Work",
  "Default": true,
  "TimeEntry": "Optional",
  "Inactive": true,
  "Movement": true,
  "Icon": "string",
  "ExternalKey": "string"
}