Pay Groups
The PayGroup object is used to represent a subset of employees that are put together for payroll processing purposes.
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.

pay_group_nameString
Optional
The pay group name.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/pay-groups

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

US
EU

Returns a list of PayGroup 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.

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

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
AllianceHCM
AllianceHCM
Freshteam
Freshteam
Keka
Keka
TriNet
TriNet
UKG Pro
UKG Pro
UKG Ready
UKG Ready
Workday
Workday
ADP Workforce Now
ADP Workforce Now
Coming soon
GET
/pay-groups/{id}

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

US
EU

Returns a PayGroup object with the given id.


Query & Path Parameters

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
AllianceHCM
AllianceHCM
Freshteam
Freshteam
Keka
Keka
TriNet
TriNet
UKG Pro
UKG Pro
UKG Ready
UKG Ready
Workday
Workday
ADP Workforce Now
ADP Workforce Now
Coming soon