Skip to main content
GET
Retrieve Projects that belong to a Company

Authorizations

Authorization
string
header
required

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

Headers

Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Path Parameters

company-id
string
required

Company ID

Query Parameters

page[limit]
integer<int32>
default:25

The maximum number of paginated results to return

Required range: x <= 100
page[after]
string

The cursor to start paginating after

page[before]
string

The cursor to stop paginating at

search[datagrid]
string

Search string for datagrid queries

filter[states]
array

Project state filters.

filter[requester_ids]
array

The associated Requester IDs

filter[external_ids]
string

The associated External IDs

filter[account_ids]
string

Account IDs filter

filter[department_ids]
array

The associated Department IDs. Use 'none' to filter for records without a Department.

filter[dispatch_number_ids]
array

The associated DispatchNumber IDs

filter[po_job_numbers]
string[]

The associated PO/Job Numbers

filter[service_class_ids]
array

The associated ServiceClass IDs

filter[equipment_type_ids]
array

The associated EquipmentType IDs

filter[foreman_ids]
array

The associated Foreman IDs

filter[collaborator_ids]
array

The associated Collaborator IDs

filter[salesperson_ids]
array

The associated Salesperson IDs

filter[pickup_site_ids]
array

The associated Pickup Site IDs

filter[dropoff_site_ids]
array

The associated Dropoff Site IDs

Response

OK

data
Project-Read · object[]
required