Skip to main content
GET
Get all corporations associated with the authenticated user

Overview

Retrieve a list of the corporations associated with the authenticated user. A corporation is a group of related companies.

Authorizations

Authorization
string
header
required

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

Query Parameters

externalId

Corporation External ID to filter by. Can be a single ID or multiple IDs separated by commas

include
boolean

Whether to include companies for each corporation in the response. If true, companies are included; if false, companies are omitted.

page
integer
default:1

Page number to retrieve. Defaults to 1.

Required range: x >= 1
limit
integer
default:25

Max number of items per page. Must be greater than 0. Defaults to 25. Maximum is 25.

Required range: 1 <= x <= 25

Response

Corporations successfully retrieved

corporations
object[]
page
object