/groups

Returns a list of Group objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

created_afterdatetimeOptional

If provided, will only return objects created after this datetime.

created_beforedatetimeOptional

If provided, will only return objects created before this datetime.

cursorstringOptional

The pagination cursor value.

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

Allowed values:

include_deleted_databooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

is_commonly_used_as_teamstringOptional

If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform.

modified_afterdatetimeOptional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforedatetimeOptional

If provided, only objects synced by Merge before this date time will be returned.

namesstringOptional

If provided, will only return groups with these names. Multiple values can be separated by commas.

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:

remote_idstringOptional

The API provider's ID for the given object.

show_enum_originsenumOptional

A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. Learn more

A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

Allowed values:

typesstringOptional

If provided, will only return groups of these types. Multiple values can be separated by commas.

Response

nextstring or null

previousstring or null

resultslist of objects

1	import requests
2
3	url = "https://api.merge.dev/api/hris/v1/groups"
4
5	querystring = {"cursor":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","expand":"parent_group","remote_fields":"type","show_enum_origins":"type"}
6
7	headers = {
8	"X-Account-Token": "X-Account-Token",
9	"Authorization": "Bearer <token>"
10	}
11
12	response = requests.get(url, headers=headers, params=querystring)
13
14	print(response.json())

1	{
2	"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
3	"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
4	"results": [
5	{
6	"id": "134e0111-0f67-44f6-98f0-597000290bb3",
7	"remote_id": "800293",
8	"created_at": "2021-09-15T00:00:00Z",
9	"modified_at": "2021-10-16T00:00:00Z",
10	"parent_group": "2ef51b11-2c4e-4b02-8d1d-50592d9e96ef",
11	"name": "COST_CENTER_US",
12	"type": "COST_CENTER",
13	"is_commonly_used_as_team": true,
14	"remote_was_deleted": true,
15	"field_mappings": {
16	"organization_defined_targets": {
17	"custom_key": "custom_value"
18	},
19	"linked_account_defined_targets": {
20	"custom_key": "custom_value"
21	}
22	},
23	"remote_data": [
24	{
25	"path": "/group"
26	}
27	]
28	}
29	]
30	}

Authentication

Headers

Query parameters

Response

Field support by integration