Retrieve all contracts.

get

https://app.officernd.com/api/v2/organizations/{orgSlug}/contracts

Retrieve a list of contracts based on provided filters

Required scopes: flex.community.contracts.read

Path Params

orgSlug

string

required

organization slug

Query Params

_id

string

Filter by the exact id of the contract.

company

string

Filter by the id of the company associated with the contract

location

string

Filter by the id of the location associated with the contract.

status

string

enum

Filter by the status of the contract.

Allowed:

stage

string

enum

Filter by the stage of the contract.

Allowed:

createdAt

string

Support date comparison filters: $gt, $gte, $lt, $lte

modifiedAt

string

Support date comparison filters: $gt, $gte, $lt, $lte

$select

string

Select fields to return

$cursorNext

string

$cursorPrev

string

$limit

number

$sort

string

^[^:]+:(asc|desc)$

Sort expression in the format <field>:<order>, where order is asc or desc

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200