Groups
The Group object is used to represent any subset of employees, such as PayGroup or Team. Employees can be in multiple Groups.
Properties
idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
parent_groupString
Optional
The parent group for this group.
nameString
Optional
The group name.
typeEnum
Optional
The group type Possible values include: TEAM, DEPARTMENT, COST_CENTER, BUSINESS_UNIT, GROUP. In cases where there is no clear mapping, the original value passed through will be returned.
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
created_atString
Required
modified_atString
Required
This is the datetime that this object was last updated by Merge
field_mappingsObject
Optional
remote_dataRemoteData[]
Optional
The Group object
JSON
{
  "id": "134e0111-0f67-44f6-98f0-597000290bb3",
  "remote_id": "800293",
  "parent_group": "2ef51b11-2c4e-4b02-8d1d-50592d9e96ef",
  "name": "COST_CENTER_US",
  "type": "COST_CENTER",
  "remote_was_deleted": true,
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}
GET
/groups

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

US
EU

Returns a list of Group 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, 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.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
remote_idString
Optional
The API provider's ID for the given object.
show_enum_originsString
Optional
Which fields should be returned in non-normalized form.
typesString
Optional
If provided, will only return groups of these types. Multiple values can be separated by commas.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "134e0111-0f67-44f6-98f0-597000290bb3",
      "remote_id": "800293",
      "parent_group": "2ef51b11-2c4e-4b02-8d1d-50592d9e96ef",
      "name": "COST_CENTER_US",
      "type": "COST_CENTER",
      "remote_was_deleted": true,
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
    }
  ]
}
Field support by platform
7Shifts
7Shifts

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString
typeEnum
ADP Workforce Now
ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString
typeEnum
AlexisHR
AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Altera Payroll
Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_dataRemoteData[]
pathstring
datastring
remote_idString
Azure Active Directory
Azure Active Directory

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
BambooHR
BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
typeEnum
Breathe
Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Ceridian Dayforce
Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Charlie
Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
ChartHop
ChartHop

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
ClayHR
ClayHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_groupString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Deel
Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Factorial
Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString
typeEnum
Freshteam
Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Google Workspace
Google Workspace

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Gusto
Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Hibob
Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
typeEnum
HR Cloud
HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
HR Partner
HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
typeEnum
HRAlliance
HRAlliance

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Humaans
Humaans

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
typeEnum
Insperity Premier
Insperity Premier

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
IntelliHR
IntelliHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_groupString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
JumpCloud
JumpCloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Justworks
Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
typeEnum
Keka
Keka

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Lucca
Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString
typeEnum
Namely
Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Officient
Officient

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Okta
Okta

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
OneLogin
OneLogin

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
OysterHR
OysterHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Paychex
Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_groupString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Paycor
Paycor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_groupString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Paylocity
Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
PeopleHR
PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
typeEnum
Personio
Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
PingOne
PingOne

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Proliant
Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Rippling
Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_groupString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Sage HR
Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
SAP SuccessFactors
SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Sapling
Sapling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
typeEnum
TriNet
TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
UKG Dimensions
UKG Dimensions

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
UKG Pro
UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
UKG Ready
UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_groupString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Workday
Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Zenefits
Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Nmbrs
Nmbrs
Coming soon
Sesame
Sesame
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
/groups/{id}

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

US
EU

Returns a Group 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.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
show_enum_originsString
Optional
Which fields should be returned in non-normalized form.
Response
JSON
{
  "id": "134e0111-0f67-44f6-98f0-597000290bb3",
  "remote_id": "800293",
  "parent_group": "2ef51b11-2c4e-4b02-8d1d-50592d9e96ef",
  "name": "COST_CENTER_US",
  "type": "COST_CENTER",
  "remote_was_deleted": true,
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}
Field support by platform
7Shifts
7Shifts

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString
typeEnum
ADP Workforce Now
ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString
typeEnum
AlexisHR
AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Altera Payroll
Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_dataRemoteData[]
pathstring
datastring
remote_idString
Azure Active Directory
Azure Active Directory

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
BambooHR
BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
typeEnum
Breathe
Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Ceridian Dayforce
Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Charlie
Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
ChartHop
ChartHop

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
ClayHR
ClayHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_groupString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Deel
Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Factorial
Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString
typeEnum
Freshteam
Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Google Workspace
Google Workspace

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Gusto
Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Hibob
Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
typeEnum
HR Cloud
HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
HR Partner
HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
typeEnum
HRAlliance
HRAlliance

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Humaans
Humaans

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
typeEnum
Insperity Premier
Insperity Premier

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
IntelliHR
IntelliHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_groupString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
JumpCloud
JumpCloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Justworks
Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
typeEnum
Keka
Keka

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Lucca
Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString
typeEnum
Namely
Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Officient
Officient

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Okta
Okta

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
OneLogin
OneLogin

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
OysterHR
OysterHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Paychex
Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_groupString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Paycor
Paycor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_groupString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Paylocity
Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
PeopleHR
PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
typeEnum
Personio
Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
PingOne
PingOne

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Proliant
Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Rippling
Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_groupString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Sage HR
Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
SAP SuccessFactors
SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Sapling
Sapling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
typeEnum
TriNet
TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
UKG Dimensions
UKG Dimensions

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
UKG Pro
UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
UKG Ready
UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
parent_groupString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Workday
Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Zenefits
Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
typeEnum
Nmbrs
Nmbrs
Coming soon
Sesame
Sesame
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
Employments
Next Up
Locations