Skip to main content
GET
List firms

Authorizations

Authorization
string
header
required

Owner-scoped bearer token. The owner all requests are scoped to is derived from the token.

Query Parameters

owner
string
required

The owner (organization) to scope the request to. Required; must be an owner your bearer token is authorized to read.

orderBy
enum<string>
default:name
Available options:
name
orderDirection
enum<string>

Sort direction.

Available options:
asc,
desc
limit
integer
default:100
Required range: 1 <= x <= 500
cursor
string

Opaque cursor from a previous response's nextCursor/previousCursor.

Response

The owner's firms.

firms
object[]
required
pagination
object
required

Cursor pagination metadata for a list response.