Return list of groups | Deel

List all the groups in your organization. Token scopes: groups:read

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

limitintegerOptional1-100Defaults to 100

The maximum number of groups to return (between 1 and 100)

sort_orderenumOptionalDefaults to ASC

Sort the results in ascending (ASC) or descending (DESC) order based on the group name.

Allowed values:

cursorstringOptional

The encoded cursor for paginated results. This is an opaque string that allows fetching the next set of results.

include_archived_groupsbooleanOptionalDefaults to true

Include archived groups (soft deleted records). Defaults to true.

external_metadatastringOptional

Extra information about the group.

Response

A list of groups in the organization.

datalist of objects or null

pageobject or null

1	import requests
2
3	url = "https://api.letsdeel.com/rest/v2/groups"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"data": [
3	{
4	"id": "grp_9f8b7c6d5e4a3b2c1d0e",
5	"name": "Engineering Team",
6	"status": "active",
7	"managers": 3,
8	"created_at": "2023-11-20T08:45:00Z",
9	"updated_at": "2024-04-10T14:22:00Z",
10	"archived_at": null,
11	"external_metadata": {
12	"department": "Product Development",
13	"location": "New York"
14	}
15	}
16	],
17	"page": {
18	"cursor": "eyJwYWdlIjoxfQ==",
19	"total_rows": 25
20	}
21	}

Authentication

Authentication

Query parameters

Response

Errors

Authentication