Source: https://atomicwork-preview.docs-staging.pageloop.ai/api-reference/users/getapi-v-1-users-segment-id-list

# Get paginated users list in a segment

GET `https://{tenant}.atomicwork.com/api/v1/users/{segment_id}/list`

## Authorization

#### X-Api-Key (header, string, required)

## Headers

#### X-Workspace-Id (header, string)

## Path Parameters

#### segment\_id (path, integer, required)

## Query Parameters

#### search\_key (query, string)

#### page (query, integer, required)

#### per\_page (query, integer)

#### sort\_order (query, enum (string))

#### is\_deleted (query, boolean)

Filter by deactivation state. true returns only deactivated users, false returns only active users. When omitted, active users are returned by default unless include\_deactivated is set. Do not add a schema default here: a materialised default makes the param non-null and renders include\_deactivated unreachable in the controller.

#### role (query, string)

#### type (query, enum (string))

Automation entity type (see allowed values in the enum schema).

#### include\_deactivated (query, boolean)

## Response

#### 200

Successful response

#### Request

```bash cURL
curl -X GET 'https://{tenant}.atomicwork.com/api/v1/users/{segment_id}/list' \
  -H 'X-Api-Key: <api-key>'
```

```javascript JavaScript
const res = await fetch('https://{tenant}.atomicwork.com/api/v1/users/{segment_id}/list', {
  method: 'GET',
  headers: {
    'X-Api-Key': '<api-key>',
  },
});
const data = await res.json();
```

```python Python
import requests

res = requests.get(
    'https://{tenant}.atomicwork.com/api/v1/users/{segment_id}/list',
    headers={'X-Api-Key': '<api-key>'}
)
data = res.json()
```