Skip to main content
GET
Retrieve Foremen for 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<uuid>
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

filter[shared]
boolean

Filter shared CompanyShareable models

search[datagrid]
string

Search string for datagrid queries

filter[expiring]
boolean

Filter based on record expiry. Default is null, which means all records are returned, true will omit non-expiring records, false will omit expiring records.

filter[sender_company_types]
array

CompanyType enum filter. See CompanyType enum for accepted values.

Response

OK

data
Foreman-Read · object[]
required