Pay Groups

The PayGroup object is used to represent a subset of employees that are put together for payroll processing purposes.

The PayGroup object

Properties

idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
pay_group_nameString
Optional
The pay group name.
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObject
Optional
remote_dataRemoteData[]
Optional
The PayGroup object
JSON
{
  "id": "fd1e0fb5-8f92-4ec9-9f32-179cf732867d",
  "remote_id": "800293",
  "pay_group_name": "contractor",
  "remote_was_deleted": true,
Show advanced fields
}
GET

/pay-groups

Returns a list of PayGroup 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, 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.
remote_idString
Optional
The API provider's ID for the given object.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "fd1e0fb5-8f92-4ec9-9f32-179cf732867d",
      "remote_id": "800293",
      "pay_group_name": "contractor",
      "remote_was_deleted": true,
Show advanced fields
    }
  ]
}
Field support by platform

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Keka

Keka

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_dataRemoteData[]
pathstring
dataobject

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
ADP Workforce Now

ADP Workforce Now

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

/pay-groups/{id}

Returns a PayGroup 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.
Response
JSON
{
  "id": "fd1e0fb5-8f92-4ec9-9f32-179cf732867d",
  "remote_id": "800293",
  "pay_group_name": "contractor",
  "remote_was_deleted": true,
Show advanced fields
}
Field support by platform

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Keka

Keka

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_dataRemoteData[]
pathstring
dataobject

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pay_group_nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
ADP Workforce Now

ADP Workforce Now

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

Locations

Next Up

Payroll Runs