Groups
TheGroup
object is used to represent any subset of employees, such as PayGroup
or Team
. Employees can be in multiple Groups.The Group object
Properties
id
Stringremote_id
Stringparent_group
Stringname
Stringtype
EnumTEAM
, DEPARTMENT
, COST_CENTER
, BUSINESS_UNIT
, or - in cases where there is no clear mapping - the original value passed through.remote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]{"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}
/groups
Returns a list of Group
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_after
Stringcreated_before
Stringcursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_fields
Stringremote_id
Stringshow_enum_origins
Stringtypes
String{"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
name
Stringremote_id
Stringtype
Enum
ADP Workforce Now
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_id
Stringtype
Enum
AlexisHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Altera Payroll
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
remote_data
RemoteData[]path
stringdata
objectremote_id
String
Azure Active Directory
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
BambooHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringtype
Enum
BizMerlinHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringparent_group
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Breathe
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Ceridian Dayforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Charlie
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
ChartHop
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Deel
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Factorial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_id
Stringtype
Enum
Freshteam
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Google Workspace
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Gusto
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_id
Stringtype
Enum
Hibob
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringtype
Enum
HR Cloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
HR Partner
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringtype
Enum
Humaans
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringtype
Enum
Insperity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
IntelliHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringparent_group
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
JumpCloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Justworks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringtype
Enum
Keka
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Lucca
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_id
Stringtype
Enum
Namely
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Officient
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Okta
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
OneLogin
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Paychex
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringparent_group
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Paycor
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringparent_group
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Paylocity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_id
Stringtype
Enum
PeopleHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objecttype
Enum
Personio
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
PingOne
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Proliant
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Rippling
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringparent_group
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Sage HR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
SAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Sapling
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringtype
Enum
TriNet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
UKG Dimensions
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
UKG Pro
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
UKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringparent_group
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Zenefits
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Nmbrs

Sesame
/groups/{id}
Returns a Group
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
id
Stringinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String{"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
name
Stringremote_id
Stringtype
Enum
ADP Workforce Now
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_id
Stringtype
Enum
AlexisHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Altera Payroll
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
remote_data
RemoteData[]path
stringdata
objectremote_id
String
Azure Active Directory
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
BambooHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringtype
Enum
BizMerlinHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringparent_group
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Breathe
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Ceridian Dayforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Charlie
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
ChartHop
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Deel
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Factorial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_id
Stringtype
Enum
Freshteam
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Google Workspace
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Gusto
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_id
Stringtype
Enum
Hibob
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringtype
Enum
HR Cloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
HR Partner
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringtype
Enum
Humaans
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringtype
Enum
Insperity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
IntelliHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringparent_group
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
JumpCloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Justworks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringtype
Enum
Keka
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Lucca
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_id
Stringtype
Enum
Namely
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Officient
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Okta
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
OneLogin
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Paychex
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringparent_group
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Paycor
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringparent_group
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Paylocity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_id
Stringtype
Enum
PeopleHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objecttype
Enum
Personio
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
PingOne
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Proliant
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Rippling
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringparent_group
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Sage HR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
SAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Sapling
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringtype
Enum
TriNet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
UKG Dimensions
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
UKG Pro
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
UKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringparent_group
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Zenefits
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtype
Enum
Nmbrs
