---
title: "List clients"
method: GET
path: "/clients"
tags: ["Clients"]
---

# List clients

`GET /clients`

## Request

- Base URL: `https://timelodge.com/api/v1`
- URL: `https://timelodge.com/api/v1/clients`
- Auth: HTTP bearer

Returns a stable, ascending-by-ID page scoped to the token workspace. Requires `clients:read`.

## Query parameters

- `page` integer
- `per_page` integer
- `currency` string, nullable
- `internal_code` string, nullable
- `updated_since` string, date-time

## Response `200`

A page of clients.

- ClientCollection
  - `data` Client[], required
    - `id` integer, nullable
    - `display_name` string, nullable
    - `legal_name` string, nullable
    - `internal_code` string, nullable
    - `currency` string, nullable
    - `billing_address` union
      - object
      - string
    - `tax_number` string, nullable
    - `locale` string, nullable
    - `notes` string, nullable
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `version` string: Opaque representation version used for optimistic concurrency.
  - `meta` PaginationMeta, required
    - `current_page` integer, required
    - `per_page` integer, required
    - `total` integer, required
    - `last_page` integer, required
  - `links` PaginationLinks, required
    - `first` string, uri, nullable
    - `last` string, uri, nullable
    - `previous` string, uri, nullable
    - `next` string, uri, nullable

## Other responses

- `401`: Missing or invalid token.
- `403`: The token lacks the required scope.
- `429`: Rate limit exceeded.

---

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