Skip to main content
GET
List contract assessments

Authorizations

Authorization
string
header
required

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

Query Parameters

take
number | null
default:50
Required range: 0 <= x <= 100
skip
number | null
default:0
Required range: x >= 0
ledger_id
string
required

Identifier of the ledger the record belongs to.

Minimum string length: 1
id
string
id__not
string
id__equals
string
id__contains
string
id__startsWith
string
id__endWith
string
subscription_id
string

Identifier of the subscription holding the contract.

Minimum string length: 1
subscription_id__not
string
subscription_id__equals
string
subscription_id__contains
string
subscription_id__startsWith
string
subscription_id__endWith
string
customer_id
string

Only contracts of this customer.

Minimum string length: 1
customer_id__not
string
customer_id__equals
string
customer_id__contains
string
customer_id__startsWith
string
customer_id__endWith
string
policy_id
string

Only contracts pinned to this revenue policy.

Minimum string length: 1
policy_id__not
string
policy_id__equals
string
policy_id__contains
string
policy_id__startsWith
string
policy_id__endWith
string
recognition_status
enum<string>

Only contracts whose latest version has this status.

Available options:
eligible,
held
recognition_status__in
Available options:
eligible,
held
review_status
enum<string>

Only contracts whose latest version has this review status.

Available options:
not_required,
pending,
approved,
rejected
review_status__in
Available options:
not_required,
pending,
approved,
rejected
id__in
string

Comma-separated identifiers: only the records with one of them.

Response

200 - application/json
meta
object
required

Pagination metadata.

data
object[]
required