GET
/
v1
/
organizations
/
{organizationId}
/
contracts

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Path Parameters

organizationId
string
required

Fabric internal id of the record.

Query Parameters

offset
integer

-Optional. Default:0. Number of records you wish to skip before selecting records.

limit
integer

Default:10. Limits the number of records returned by the api.

sortOrder
enum<string>

sort directions of the retrieved records. Default value desc.

Available options:
asc,
desc
sortBy
enum<string>

sort field of the retrieved records. Default value updatedAt.

Available options:
contractId,
organizationName,
startDate,
endDate,
status,
priceListId,
updatedAt
startDateFrom
string

start date of the contracts to filter. If sent also startDateTo must be sent.

startDateTo
string

start date of the contracts to filter. If sent also startDateFrom must be sent.

endDateFrom
string

end date of the contracts to filter. If sent also endDateTo must be sent.

endDateTo
string

end date of the contracts to filter. If sent also endDateFrom must be sent.

search
string

it will be compared against the name of the party of the contract.

status
enum<string>

status of the contracts to be retrieved.

Available options:
DRAFT,
INACTIVE,
ACTIVE

Response

200 - application/json
query
object

data about pagination.

data
object[]

Was this page helpful?

Update organization contractCreate organization contract