Skip to main content

Get contract

GET 
/api/v2/Contracts/:key

Get contract

Request​

Path Parameters

    key stringrequired

    Guid or ExternalKey

Responses​

Success

Schema

    Guid guid
    Revision int64
    PersonCreated guidnullable
    PersonChanged guidnullable
    TimestampCreated date-timenullable
    Example: 2024-10-07T12:48:00Z
    TimestampChanged date-timenullable
    Example: 2024-10-07T12:48:00Z
    Name stringnullablerequired
    Code stringnullable
    Customer guidnullable
    ResponsiblePerson guidnullable
    Description stringnullable
    StartDate datenullable
    EndDate datenullable
    Billable BillableFlags (string)

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

    Note stringnullable
    CustomFields objectnullable
    Example: {"MyCustomField":"value","MyNestedObject":{"MyNestedProperty":"value"}}
    ExternalKey stringnullable
    States string[]nullable
    ContactPerson stringnullable

    Possible values: <= 50 characters

    ContactPhone stringnullable

    Possible values: <= 30 characters

    ContactEmail stringnullable

    Possible values: <= 65 characters

    CompletionDate date-timenullable
    Branch guidnullable
Loading...