Companies

The Company object is used to represent a Company within the HRIS / Payroll system.

The Company object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

legal_nameString
Optional
The company's legal name.

display_nameString
Optional
The company's display name.

einsArray
Optional
The company's Employer Identification Numbers.

remote_dataRemoteData[]
Optional

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

The Company object
JSON
{
"id": "1b998423-db0a-4037-a4cf-f79c60cb67b3",
"remote_id": "19202938",
"legal_name": "Waystar Royco, Inc.",
"display_name": "Waystar Royco",
"eins": [
"12-3456789",
"12-3451111",
"11-0011000"
],
"remote_data": [
{
"path": "/companies",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true
}

GET

/companies

Returns a list of Company objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "1b998423-db0a-4037-a4cf-f79c60cb67b3",
"remote_id": "19202938",
"legal_name": "Waystar Royco, Inc.",
"display_name": "Waystar Royco",
"eins": [
"12-3456789",
"12-3451111",
"11-0011000"
],
"remote_data": [
{
"path": "/companies",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true
}
]
}
Field support by platform

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

AlexisHR

AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

remote_idString

Altera Payroll

Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_idString

Breathe

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Charlie

Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

ChartHop

ChartHop

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Deel

Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_idString

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

Humaans

Humaans

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

remote_idString

IntelliHR

IntelliHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString

JumpCloud

JumpCloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Justworks

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

Lucca

Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Namely

Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

Nmbrs

Nmbrs

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

remote_idString

Officient

Officient

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Okta

Okta

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

OneLogin

OneLogin

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

PayCaptain

PayCaptain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

remote_idString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

remote_dataRemoteData[]

PeopleHR

PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

Proliant

Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString

Sesame

Sesame

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

remote_idString

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/companies/{id}

Returns a Company object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"id": "1b998423-db0a-4037-a4cf-f79c60cb67b3",
"remote_id": "19202938",
"legal_name": "Waystar Royco, Inc.",
"display_name": "Waystar Royco",
"eins": [
"12-3456789",
"12-3451111",
"11-0011000"
],
"remote_data": [
{
"path": "/companies",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true
}
Field support by platform

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

AlexisHR

AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

remote_idString

Altera Payroll

Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_idString

Breathe

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Charlie

Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

ChartHop

ChartHop

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Deel

Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_idString

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

Humaans

Humaans

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

remote_idString

IntelliHR

IntelliHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString

JumpCloud

JumpCloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Justworks

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

Lucca

Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Namely

Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

Nmbrs

Nmbrs

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

remote_idString

Officient

Officient

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Okta

Okta

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

OneLogin

OneLogin

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

PayCaptain

PayCaptain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

remote_idString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

remote_dataRemoteData[]

PeopleHR

PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

Proliant

Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString

Sesame

Sesame

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

remote_idString

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

remote_dataRemoteData[]

remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

remote_dataRemoteData[]

remote_idString

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_dataRemoteData[]

remote_idString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Benefits

Next Up

Deductions