List deliverables

GET

deliverable

List deliverables

curl --request GET \
  --url https://{instance}/api/v2/deliverable \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{instance}/api/v2/deliverable', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{instance}/api/v2/deliverable"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "values": [
    {}
  ],
  "hasMore": true
}

Authorizations

X-API-Key

string

header

required

Query Parameters

page

integer

default:1

Required range: x >= 1

pageSize

integer

default:50

orderBy

string

Example:

"name:asc"

select

string[]

Fields to include in the response. Repeat the parameter per field (e.g. '?select=id&select=name') — a single comma-separated value is not supported and is silently ignored. For POST /query, pass 'select' as a JSON array in the body instead.

Example:

["id", "name", "identifier"]

string

filter

string

Response

200 - application/json

List of deliverables

values

object[]

hasMore

boolean

Get deliverable

List deliverables

curl --request GET \
  --url https://{instance}/api/v2/deliverable \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{instance}/api/v2/deliverable', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{instance}/api/v2/deliverable"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "values": [
    {}
  ],
  "hasMore": true
}

Overview

Projects

Stages

Deliverables

Work sessions

Dependencies

Comments

Documents

Notes

Notifications

QC

People (Workers)

Timesheets

Organization

Concepts

Authorizations

Query Parameters

Response