Companies

The Company object is used to represent a Company.

The Company object

Properties


idString
Optional

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

The Company object

{
  "id": "1b998423-db0a-4037-a4cf-f79c60cb67b3",
  "remote_id": "19202938",
  "legal_name": "We Love Integrations Inc.",
  "display_name": "We Love Integrations",
  "eins": [
    "12-3456789",
    "12-3451111",
    "11-0011000"
  ],
  "remote_data": [
    {
      "path": "/companies",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}

GET

/companies

Returns a list of Company objects.


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_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

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

Gusto

Gusto

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_idString

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

remote_idString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

einsArray

remote_idString

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

display_nameString

legal_nameString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

einsArray

remote_idString

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_idString

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

einsArray

remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

einsArray

remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

einsArray

remote_idString

Humaans.io

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

remote_idString

Justworks

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

Nmbrs

Nmbrs

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

remote_idString

Namely

Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

display_nameString

einsArray

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_idString
GET

/companies/{id}

Returns a Company object with the given id.


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

{
  "id": "1b998423-db0a-4037-a4cf-f79c60cb67b3",
  "remote_id": "19202938",
  "legal_name": "We Love Integrations Inc.",
  "display_name": "We Love Integrations",
  "eins": [
    "12-3456789",
    "12-3451111",
    "11-0011000"
  ],
  "remote_data": [
    {
      "path": "/companies",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

Gusto

Gusto

Supported Response Fields


display_nameString

einsArray

legal_nameString

remote_idString

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

remote_idString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

einsArray

remote_idString

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

display_nameString

legal_nameString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

einsArray

remote_idString

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

remote_idString

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

einsArray

remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

einsArray

remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

einsArray

remote_idString

Humaans.io

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

remote_idString

Justworks

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

einsArray

Nmbrs

Nmbrs

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


legal_nameString

remote_dataRemoteData[]

display_nameString

remote_idString

Namely

Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_nameString

legal_nameString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

display_nameString

einsArray

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_idString