Show User Pool

GET

/companies/%7Bcompany_id%7D/config/automation/user-pools/%7Buser_pool_uuid%7D

GET

/companies/%7Bcompany_id%7D/config/automation/user-pools/%7Buser_pool_uuid%7D

1 curl https://https//https/companies/%7Bcompany_id%7D/config/automation/user-pools/%7Buser_pool_uuid%7D \
2      -H "{{tenant_key_name}}: {{tenant_key_value1}}|{{tenant_key_value2}}" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "userPoolUuid": "a3f1c9d2-4b7e-4f8a-9c3d-2e5f7b8a9c1d",
3   "companyId": "987654321",
4   "name": "Marketing Team Pool",
5   "description": "User pool for marketing department automation",
6   "createdAt": "2024-05-10T09:15:00Z",
7   "members": [
8     {
9       "userId": "user-12345",
10       "email": "jane.doe@example.com",
11       "role": "admin",
12       "joinedAt": "2023-11-01T08:30:00Z",
13       "active": true
14     },
15     {
16       "userId": "user-67890",
17       "email": "john.smith@example.com",
18       "role": "member",
19       "joinedAt": "2023-12-15T14:45:00Z",
20       "active": true
21     },
22     {
23       "userId": "user-54321",
24       "email": "alice.jones@example.com",
25       "role": "member",
26       "joinedAt": "2024-01-20T11:00:00Z",
27       "active": false
28     }
29   ]
30 }

Show a single user pool including its members.

Response

Successful response

Headers

Response