Teams

The Team object is used to represent a Team within a company. Employee objects are often grouped this way. Note that in the Merge HRIS API, company subdivisions are all represented with Teams, rather than Teams and Departments.

The Team object

Properties

idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
nameString
Optional
The team's name.
parent_teamString
Optional
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
The Team object
JSON
{
  "id": "13a72919-9fae-4f54-81ca-ddfd8712a1ba",
  "remote_id": "19202938",
  "name": "Engineering",
  "parent_team": "1b998423-db0a-4037-a4cf-f79c60cb67b3",
  "remote_was_deleted": true
}
GET

/teams

Returns a list of Team 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.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
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.
parent_team_idString
Optional
If provided, will only return teams with this parent team.
remote_idString
Optional
The API provider's ID for the given object.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "13a72919-9fae-4f54-81ca-ddfd8712a1ba",
      "remote_id": "19202938",
      "name": "Engineering",
      "parent_team": "1b998423-db0a-4037-a4cf-f79c60cb67b3",
      "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

nameString
remote_idString

AlexisHR

AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_teamString
remote_idString

BambooHR

BambooHR

Breathe

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Ceridian Dayforce

Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

CharlieHR

CharlieHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

ChartHop

ChartHop

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Deel

Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Factorial

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Hibob

Hibob

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

HR Partner

HR Partner

Humaans.io

Humaans.io

Justworks

Justworks

Lucca

Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Namely

Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Nmbrs

Nmbrs

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_teamString
remote_idString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

PeopleHR

PeopleHR

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_teamString
remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_idString

Sapling

Sapling

Sesame

Sesame

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_teamString
remote_idString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString
Breathe

Breathe

Coming Soon
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

/teams/{id}

Returns a Team 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

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
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": "13a72919-9fae-4f54-81ca-ddfd8712a1ba",
  "remote_id": "19202938",
  "name": "Engineering",
  "parent_team": "1b998423-db0a-4037-a4cf-f79c60cb67b3",
  "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

nameString
remote_idString

AlexisHR

AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_teamString
remote_idString

BambooHR

BambooHR

Breathe

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Ceridian Dayforce

Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

CharlieHR

CharlieHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

ChartHop

ChartHop

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Deel

Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Factorial

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Hibob

Hibob

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

HR Partner

HR Partner

Humaans.io

Humaans.io

Justworks

Justworks

Lucca

Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Namely

Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Nmbrs

Nmbrs

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_teamString
remote_idString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

PeopleHR

PeopleHR

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_teamString
remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_idString

Sapling

Sapling

Sesame

Sesame

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_teamString
remote_idString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString
Breathe

Breathe

Coming Soon
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

Payroll Runs

Next Up

Time Off