# List clients — API reference

> Returns clients with optional filters, sorting, cursor and page-size parameters.

Source: https://upfour.io/docs/api/clients/list-clients

[Developers](https://upfour.io/docs/api.md)/[Clients (agency mode)](https://upfour.io/docs/api/clients.md)

Returns clients with optional filters, sorting, cursor and page-size parameters.

GET https://app.upfour.io/v1/clients

scope client.read stable returns 200

## Parameters

| Field | Type | Description |
| --- | --- | --- |
| `limit` optional | integer 1–250 default `50` | query parameter |
| `cursor` optional | string | query parameter |
| `client_id` optional | uuid | query parameter |
| `all_clients` optional | boolean | query parameter |
| `q` optional | string | query parameter |
| `sort` optional | string | query parameter |

## Returns

A successful request returns `200` with application/json.

Response fields 2 top-level fields

| Field | Type | Description |
| --- | --- | --- |
| `data` | Client[]  · nullable | |
| Each item · 20 fields FieldTypeDescription `allow_login` boolean `contact_email` string `created_at` string (date-time) `id` uuid `language` string  · nullable one of`en` `de` `logo` StoredClientLogo StoredClientLogo · 4 fields FieldTypeDescription `background` string one of`light` `dark` `transparent` The background the logo is made for. `dark` string Same as standard, for dark backgrounds. Needs a standard logo. `icon` string Same as standard, for compact places. Needs a standard logo. `standard` string Request: a PNG as data:image/png;base64,... of at most 192 KiB, or the value the client already has to keep that image; empty removes it. Response: the path of the stored image. `logo_url` string A hosted logo; empty once a standard logo is stored. `name` string `organization_id` uuid `slug` string `timezone` string `updated_at` string (date-time) `archived_at` string (date-time) Set while the client is archived. `effective_language` string one of`en` `de` Only in the answer for one client: the language the client actually gets, its own or the company default. `monitor_count` integer Only in lists, omitted when zero. `open_incidents` integer Only in lists, omitted when zero. | | |
| `pagination` | Pagination | |
| Pagination · 5 fields FieldTypeDescription `cursor` string  · nullable `has_more` boolean `limit` integer 1–250 `next_cursor` string  · nullable `prev_cursor` string  · nullable | | |

## Errors

Only the errors this operation can return. Every error uses the [same envelope](https://upfour.io/docs/api/responses.md).

| Status | Code | Meaning |
| --- | --- | --- |
| 400 | [bad_request](https://upfour.io/docs/api/errors#code-bad_request) | The request is malformed or fails validation. |
| 404 | [not_found](https://upfour.io/docs/api/errors#code-not_found) | The requested resource does not exist or is outside the caller's scope. |

Every call can also return `unauthorized` (401), `rate_limit_exceeded` (429) or `internal_error` (500 / 502). See [Responses and errors](https://upfour.io/docs/api/responses.md).

[NextCreate a client](https://upfour.io/docs/api/clients/create-a-client.md)

## Request

### cURL

```bash
curl -s "https://app.upfour.io/v1/clients" \
  -H "Authorization: Bearer $UP4_API_KEY"
```

### JavaScript

```javascript
const res = await fetch("https://app.upfour.io/v1/clients", {
  headers: {
    Authorization: `Bearer ${process.env.UP4_API_KEY}`,
  },
});
console.log(res.status, await res.json());
```

### Python

```python
import os
import requests

res = requests.get(
    "https://app.upfour.io/v1/clients",
    headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"},
)
print(res.status_code, res.json())
```

### Go

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://app.upfour.io/v1/clients", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}
```

### PHP

```php
<?php
$ch = curl_init("https://app.upfour.io/v1/clients");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("UP4_API_KEY"),
    ],
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n";
curl_close($ch);
```

## Response

### 200

```json
{
  "data": [
    {
      "allow_login": false,
      "contact_email": "anna@example.com",
      "created_at": "2026-10-27T09:00:00Z",
      "id": "00000000-0000-4000-8000-000000000001",
      "language": "en",
      "logo": {
        "background": "light",
        "dark": "",
        "icon": "",
        "standard": ""
      },
      "logo_url": "",
      "name": "Globex Corp",
      "organization_id": "00000000-0000-4000-8000-000000000002",
      "slug": "globex",
      "timezone": "Europe/Berlin",
      "updated_at": "2026-10-27T09:00:00Z"
    }
  ],
  "pagination": {
    "cursor": null,
    "has_more": false,
    "limit": 50,
    "next_cursor": null,
    "prev_cursor": null
  }
}
```

### 400

```json
{
  "error": {
    "code": "bad_request",
    "message": "The request is malformed or fails validation.",
    "request_id": "req_…"
  }
}
```

### 404

```json
{
  "error": {
    "code": "not_found",
    "message": "The requested resource does not exist or is outside the caller's scope.",
    "request_id": "req_…"
  }
}
```