Skip to main content

Get contract

GET 
/api/v2/Contracts/:key

Get contract

Request​

Path Parameters

    key stringrequired

    Guid or ExternalKey

Responses​

Success

Schema

    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