Get workspace agent group members

GET

https://{tenant}.atomicwork.com/api/v1/workspaces/:workspace_id/agent-groups/:agent_group_id/members

GET

/api/v1/workspaces/:workspace_id/agent-groups/:agent_group_id/members

$ curl -G https://{tenant}.atomicwork.com/api/v1/workspaces/1/agent-groups/1/members \
>      -H "X-Workspace-Id: 42" \
>      -H "X-Api-Key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d page=1 \
>      -d sort_order=CREATED_AT_DESC \
>      -d filter=ALL \
>      -d search_key=john.doe \
>      -d per_page=25

200Retrieved

1 {
2   "members": [
3     {
4       "id": 101,
5       "name": "John Doe",
6       "email": "john.doe@example.com",
7       "role": "Agent",
8       "assigned": true,
9       "created_at": "2024-04-10T09:15:00Z",
10       "updated_at": "2024-05-01T12:00:00Z"
11     },
12     {
13       "id": 102,
14       "name": "Jane Smith",
15       "email": "jane.smith@example.com",
16       "role": "Agent",
17       "assigned": false,
18       "created_at": "2024-03-22T14:30:00Z",
19       "updated_at": "2024-04-15T08:45:00Z"
20     }
21   ],
22   "page": 1,
23   "per_page": 25,
24   "total": 2,
25   "next_page_token": null
26 }

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

workspace_idlongRequired

Workspace ID (numeric). Find yours under Settings → Workspace.

agent_group_idlongRequired

Query parameters

search_keystringOptional>=1 character

pageintegerRequired1-100Defaults to 1

per_pageintegerOptional1-1000Defaults to 25

sort_orderenumOptional

filterenumOptional

Allowed values:

Response

Successful response

Authentication

Path parameters

Headers

Query parameters

Response