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 the Group common model as it has the same capabilities as Teams and is more comprehensive. If you have any questions, please contact us.
Properties

idUUID
Required

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

created_atDateTime (ISO 8601)
Required
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
Required
The datetime that this object was modified by Merge.

nameString
Optional
The team's name.

parent_teamUUID
Optional
The team's parent team.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/teams

https://api.merge.dev/api/hris/v1/teams

US
EU
APAC

Returns a list of Team objects.


Query & Path Parameters

created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)
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
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

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

include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)
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.

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
ADP Workforce Now
AlexisHR
AlexisHR
BambooHR
BambooHR
Breathe
Breathe
Charlie
Charlie
ChartHop
ChartHop
Dayforce
Dayforce
Deel
Deel
Factorial
Factorial
Freshteam
Freshteam
Google Workspace
Google Workspace
Gusto
Hibob
Hibob
HR Cloud
HR Cloud
HR Partner
HR Partner
Humaans
Humaans
JumpCloud
JumpCloud
Justworks
Justworks
Kallidus
Kallidus
Keka
Keka
Lucca
Lucca
Namely
Namely
Nmbrs
Nmbrs
Officient
Officient
Okta
Okta
OneLogin
OneLogin
PayCaptain
PayCaptain
Paychex
Paychex
Paycor
Paycor
Paylocity
Paylocity
PeopleHR
PeopleHR
Personio
Personio
Rippling
Rippling
Sage HR
Sage HR
SAP SuccessFactors
SAP SuccessFactors
Sesame
Sesame
TriNet
TriNet
TriNet HR Platform
TriNet HR Platform
UKG Pro
UKG Pro
UKG Ready
UKG Ready
Workday
Workday
GET
/teams/{id}

https://api.merge.dev/api/hris/v1/teams/{id}

US
EU
APAC

Returns a Team object with the given id.


Query & Path Parameters

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
ADP Workforce Now
AlexisHR
AlexisHR
BambooHR
BambooHR
Breathe
Breathe
Charlie
Charlie
ChartHop
ChartHop
Dayforce
Dayforce
Deel
Deel
Factorial
Factorial
Freshteam
Freshteam
Google Workspace
Google Workspace
Gusto
Hibob
Hibob
HR Cloud
HR Cloud
HR Partner
HR Partner
Humaans
Humaans
JumpCloud
JumpCloud
Justworks
Justworks
Kallidus
Kallidus
Keka
Keka
Lucca
Lucca
Namely
Namely
Nmbrs
Nmbrs
Officient
Officient
Okta
Okta
OneLogin
OneLogin
PayCaptain
PayCaptain
Paychex
Paychex
Paycor
Paycor
Paylocity
Paylocity
PeopleHR
PeopleHR
Personio
Personio
Rippling
Rippling
Sage HR
Sage HR
SAP SuccessFactors
SAP SuccessFactors
Sesame
Sesame
TriNet
TriNet
TriNet HR Platform
TriNet HR Platform
UKG Pro
UKG Pro
UKG Ready
UKG Ready
Workday
Workday