Skip to main content
GET
/
contracts
Get contracts
curl --request GET \
  --url https://api.projectcor.com/v1/contracts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "with_milestones": true,
  "with_ratecards": true,
  "with_positions": true,
  "status": "expired",
  "type": "time_and_materials"
}
'
{
  "total": "<string>",
  "perPage": "<string>",
  "page": "<string>",
  "data": [
    {
      "id": 123,
      "client_id": 123,
      "json_integrations": {},
      "name": "<string>",
      "type": "<string>",
      "source": "<string>",
      "status": "<string>",
      "company_id": 123,
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "frequency": "<string>",
      "currency_id": 123,
      "currency": {
        "id": 123,
        "name": "<string>"
      },
      "url": "<string>",
      "url_name": "<string>",
      "user_positions_header_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page
default:1

Page number (default: 1). Set to false to disable pagination.

perPage
integer
default:20

Number of items per page (default: 20).

filters
string

URL-encoded JSON object with filter criteria.

Body

application/json
with_milestones
boolean

Include milestones in each contract response.

with_ratecards
boolean

Include ratecards in each contract response.

with_positions
boolean

Include contract positions in each contract response.

status
string

Filter contracts by status.

Example:

"expired"

type
string

Filter contracts by type.

Example:

"time_and_materials"

Response

200 - application/json

Paginated list of contracts

Paginated response for contracts list

total

Total number of contracts

perPage

Number of items per page

page

Current page number

data
object[]

Array of contracts for the current page