Teams
The Team object is used to represent a subdivision of the company, usually a department. Each employee will be grouped into one specific Team.
Merge will no longer support the Team common model after April 20th, 2023. This means we will not add any improvements or support any bug fixes related to Teams. We strongly recommend using Groups as it has the same capabilities as Teams and is more comprehensive. If you have any questions, please contact us.

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
The team's parent team.

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

field_mappingsObject
Optional

modified_atString
Required
This is the datetime that this object was last updated by Merge

remote_dataRemoteData[]
Optional

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,
Show advanced fields
}

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, only objects synced by Merge after this date time will be returned.

modified_beforeString
Optional
If provided, only objects synced by Merge before this date time will be returned.

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,
Show advanced fields
}
]
}
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_dataRemoteData[]
pathstring
dataobject

remote_idString
BambooHR
BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
Breathe
Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Ceridian Dayforce
Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Charlie
Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
ChartHop
ChartHop

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Deel
Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Factorial
Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Freshteam
Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Google Workspace
Google Workspace

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
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_dataRemoteData[]
pathstring
dataobject

remote_idString
HR Partner
HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
Humaans
Humaans
JumpCloud
JumpCloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
Justworks
Justworks
Keka
Keka

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Lucca
Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Namely
Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Nmbrs
Nmbrs

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Officient
Officient

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Okta
Okta
OneLogin
OneLogin
PayCaptain
PayCaptain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
Paychex
Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

parent_teamString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Paycor
Paycor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

parent_teamString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Paylocity
Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
PeopleHR
PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
Personio
Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Rippling
Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

parent_teamString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Sage HR
Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
SAP SuccessFactors
SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Sapling
Sapling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
Sesame
Sesame

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
TriNet
TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
UKG Pro
UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
UKG Ready
UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

parent_teamString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Workday
Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Zenefits
Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
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,
Show advanced fields
}
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_dataRemoteData[]
pathstring
dataobject

remote_idString
BambooHR
BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
Breathe
Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Ceridian Dayforce
Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Charlie
Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
ChartHop
ChartHop

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Deel
Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Factorial
Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Freshteam
Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Google Workspace
Google Workspace

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
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_dataRemoteData[]
pathstring
dataobject

remote_idString
HR Partner
HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
Humaans
Humaans
JumpCloud
JumpCloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
Justworks
Justworks
Keka
Keka

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Lucca
Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Namely
Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Nmbrs
Nmbrs

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Officient
Officient

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Okta
Okta
OneLogin
OneLogin
PayCaptain
PayCaptain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
Paychex
Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

parent_teamString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Paycor
Paycor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

parent_teamString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Paylocity
Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
PeopleHR
PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
Personio
Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Rippling
Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

parent_teamString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Sage HR
Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
SAP SuccessFactors
SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Sapling
Sapling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject
Sesame
Sesame

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
TriNet
TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
UKG Pro
UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
UKG Ready
UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

parent_teamString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Workday
Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Zenefits
Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Hint: Use the /linked-accounts endpoint to pull platform support information.