---
title: "Retrieve clients list"
method: GET
path: "/clients/"
tags: ["client"]
---

# Retrieve clients list

`GET /clients/`

## Request

- Base URL: `https://api.angelcam.com/v1`
- URL: `https://api.angelcam.com/v1/clients/`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://my.angelcam.com/oauth/authorize/`, token URL `https://my.angelcam.com/oauth/token/`
    - Password, token URL `https://api.angelcam.com/oauth/token/`
    - Scopes: `client_access`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/angelcam/apis/angelcam-api/docs/clients/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Returns client list.

- ClientListResponse
  - `count` integer, required: Count of client
  - `next` string, uri, nullable, required: Next page from pagination
  - `previous` string, uri, nullable, required: Previous page from pagination
  - `results` ClientObject[], required: List of clients of reseller
    - `id` integer, required: Client ID
    - `first_name` string, required: Clients first name
    - `last_name` string, required: Clients last name
    - `email` string, email, required: Clients email
    - `phone` string, nullable, required: Clients phone number
    - `invoice_to` 'me' | 'client', required: All services are invoice to reseller (me) or directly to client.
    - `limited_account` boolean, required: Limited clients cannot connect new cameras or purchase any services, by themselves.
    - `allowed_access` boolean, required: This field indicates if reseller can access clients cameras. Defualt is true, but client can refuse access.
    - `activated_at` string, datetime, nullable, required: Datetime, when client activated their account, or null in a case when the account is not activated yet at all.

## Other responses

- `401`: Missing or invalid authorization.
- `403`: Missing permission.

---

[API](https://skmtc.dev/angelcam/apis/angelcam-api.md) - [All operations](https://skmtc.dev/angelcam/apis/angelcam-api/llms.txt) - [OpenAPI document](https://skmtc.dev/angelcam/apis/angelcam-api/revisions/dd1cdc3f2c23?raw)