Appearance

List Companies ​

Endpoint ​

http
GET /unified/hris/companies
Integrations supported
  • Okta

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d

Response Body ​

result
object[]
List of Companies
id
string
REQUIRED · The unique identifier for companies
Supported in
  • Okta
legal_name
string
This represents the legal name
display_name
string
This represents the display name
Supported in
  • Okta
enis
string[]
This represents the company's Employer Identification Numbers.
created_at
string
This represents the date when the companies was created
Supported in
  • Okta
updated_at
string
This represents the date when the companies was updated
Supported in
  • Okta
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.