v1
latestOpenAPI 3.0.02026-07-24161215397.4 KBContracts
Get contracts count by filter
Retrieve a count of contracts based on provided filters
Required scopes: flex.community.contracts.read
get/api/v2/organizations/{orgSlug}/contracts/count
Path parameters
orgSlugstring required
organization slug
Query parameters
_idstring
Example:6080186f490fcf6e0547ec52
Filter by the exact id of the contract.
companystring
Example:6080186f490fcf6e0547ec55
Filter by the id of the company associated with the contract
locationstring
Example:6080186f490fcf6e0547ec58
Filter by the id of the location associated with the contract.
status'signed' | 'draft' | 'terminated' | 'not_signed' | 'canceled'
The status of the contract.
Filter by the status of the contract.
stage'terminated' | 'served_notice' | 'active' | 'up_for_renewal' | 'not_renewed' | 'expired' | 'rolling'
The stage of the contract.
Filter by the stage of the contract.
createdAtstring
Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ
Support date comparison filters: $gt, $gte, $lt, $lte
modifiedAtstring
Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ
Support date comparison filters: $gt, $gte, $lt, $lte
$countBy'status' | 'company' | 'location'
The field to count by