# Get client list

`GET /api/v1/Outlets/{outletId}/Clients`

Core API · OutletClients · base URL `https://core-api.ancon.io` · auth: `Access-Token` header · docs: https://ancon.dev/api/core/outlet-clients/get-client-list

### Available filter properties
- created (datetime)
- name (string)
- clienttype (string)

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `outletId` | string (uuid) | yes |  |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `Offset` | integer (int32) | no | Offset the result, defaults to 0 |
| `Limit` | integer (int32) | no | Limits how many items to get, defaults to 100 min 0, max 1000. |
| `Order` | string | no | Order the result. |
| `Search` | string | no |  |
| `Filter` | map<string, array<string>> | no | Filter the result. Filter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00 |

## Header parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `correlationId` | string | no | Correlation Id for the request |

## Responses

| Status | Description |
| --- | --- |
| 200 | OK |
| 401 | Unauthorized |
| 404 | Not Found |

### 200 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | array<object> or null | no |  |
| `items[].id` | string (uuid) | no |  |
| `items[].name` | string or null | no |  |
| `items[].lastOnline` | string (date-time) | no |  |
| `items[].clientType` | integer (int32) | no | Allowed values: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`. |
| `items[].isLinked` | boolean | no |  |
| `meta` | object or null | no |  |
| `meta.count` | integer (int32) | no |  |
| `meta.offset` | integer (int32) | no |  |

#### Example (from schema)

```json
{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "lastOnline": "2026-01-15T12:00:00Z",
      "clientType": 0,
      "isLinked": true
    }
  ],
  "meta": {
    "count": 0,
    "offset": 0
  }
}
```

### 401 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `message` | string or null | no |  |

#### Example (from schema)

```json
{
  "message": "string"
}
```

### 404 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `message` | string or null | no |  |
| `errorCode` | string (uuid) | no |  |

#### Example (from schema)

```json
{
  "message": "string",
  "errorCode": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

## Example request

```bash
curl -X GET "https://core-api.ancon.io/api/v1/Outlets/{outletId}/Clients" \
  -H "Access-Token: $ANCON_TOKEN"
```