Groups

The Group object is used to represent any subset of employees, such as PayGroup or Team. Employees can be in multiple Groups.

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.

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,
Show advanced fields
}

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

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,
Show advanced fields
    }
  ]
}

7Shifts

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

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_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Azure Active Directory

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

typeEnum

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

parent_groupString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

ChartHop

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Factorial

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_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Google Workspace

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

typeEnum

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

typeEnum

Humaans

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

typeEnum

Insperity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

IntelliHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

parent_groupString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

JumpCloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

typeEnum

Keka

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Supported Response Fields

nameString

remote_idString

typeEnum

PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

typeEnum

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

PingOne

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

parent_groupString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Nmbrs

Coming Soon

Sesame

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

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,
Show advanced fields
}

7Shifts

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

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_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Azure Active Directory

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

typeEnum

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

parent_groupString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Charlie

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

ChartHop

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Factorial

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_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Google Workspace

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

pathstring

dataobject

remote_idString

typeEnum

JumpCloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

typeEnum

Keka

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

typeEnum

PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

typeEnum

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

PingOne

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

parent_groupString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

typeEnum

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

Coming Soon

Sesame

Coming Soon

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

Employments