Groups

The Group object is used to represent Group information that employees belong to. This is often referenced with an Employee object.

Please note: The teams object will fulfill most use cases. The Groups object is for power-users that want all types of groups at a company and the optionality of pulling multiple groups for an employee.

The Group object

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, or - in cases where there is no clear mapping - the original value passed through.

remote_was_deletedBoolean

Required

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

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
}

GET

/groups

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, 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_fieldsString

Optional

Which fields should be returned in non-normalized form.

remote_idString

Optional

The API provider's ID for the given object.

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
    }
  ]
}

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_idString

CharlieHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

IntelliHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

parent_groupString

remote_idString

typeEnum

Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

parent_groupString

remote_idString

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

Rippling

Coming Soon

BambooHR

Coming Soon

Sage HR

Coming Soon

Hibob

Coming Soon

Zenefits

Coming Soon

Breathe

Coming Soon

HR Partner

Coming Soon

Factorial

Coming Soon

Sapling

Coming Soon

Humaans.io

Coming Soon

HR Cloud

Coming Soon

Paylocity

Coming Soon

Paychex

Coming Soon

Nmbrs

Coming Soon

Ceridian Dayforce

Coming Soon

ChartHop

Coming Soon

Sesame

Coming Soon

PeopleHR

Coming Soon

Lucca

Coming Soon

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

GET

/groups/{id}

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

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
}

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_idString

CharlieHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

IntelliHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

parent_groupString

remote_idString

typeEnum

Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

parent_groupString

remote_idString

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

Rippling

Coming Soon

BambooHR

Coming Soon

Sage HR

Coming Soon

Hibob

Coming Soon

Zenefits

Coming Soon

Breathe

Coming Soon

HR Partner

Coming Soon

Factorial

Coming Soon

Sapling

Coming Soon

Humaans.io

Coming Soon

HR Cloud

Coming Soon

Paylocity

Coming Soon

Paychex

Coming Soon

Nmbrs

Coming Soon

Ceridian Dayforce

Coming Soon

ChartHop

Coming Soon

Sesame

Coming Soon

PeopleHR

Coming Soon

Lucca

Coming Soon

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

Employments

Next Up

Locations

Groups

The Group object

Properties

/groups

Header Parameters

Query & Path Parameters

ADP Workforce Now

AlexisHR

Altera Payroll

CharlieHR

Deel

Freshteam

IntelliHR

Namely

Personio

Proliant

SAP SuccessFactors

TriNet

UKG Pro

UKG Ready

Workday

Rippling

BambooHR

Sage HR

Hibob

Zenefits

Breathe

HR Partner

Factorial

Sapling

Humaans.io

HR Cloud

Paylocity

Paychex

Nmbrs

Ceridian Dayforce

ChartHop

Sesame

PeopleHR

Lucca

/groups/{id}

Header Parameters

Query & Path Parameters

ADP Workforce Now

AlexisHR

Altera Payroll

CharlieHR

Deel

Freshteam

IntelliHR

Namely

Personio

Proliant

SAP SuccessFactors

TriNet

UKG Pro

UKG Ready

Workday

Rippling

BambooHR

Sage HR

Hibob

Zenefits

Breathe

HR Partner

Factorial

Sapling

Humaans.io

HR Cloud

Paylocity

Paychex

Nmbrs

Ceridian Dayforce

ChartHop

Sesame

PeopleHR

Lucca

Previous

Next Up

Get Started