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

# List clients

`GET /clients`

## Request

- Base URL: `https://www.ruddr.io/api/workspace`
- URL: `https://www.ruddr.io/api/workspace/clients`
- Auth: HTTP bearer

## Query parameters

- `startingAfter` string
- `endingBefore` string
- `limit` integer
- `modifiedAtAfter` union
  - string, date
  - string, date-time
- `modifiedAtOnAfter` union
  - string, date
  - string, date-time
- `modifiedAtBefore` union
  - string, date
  - string, date-time
- `modifiedAtOnBefore` union
  - string, date
  - string, date-time
- `code` string

## Response `200`

200

- object
  - `results` Client[]: The list of results for the current page.
    - `id` string: The unique identifier for the object.
    - `key` string: The URL-friendly slug for the client.
    - `name` string: The name of the client.
    - `code` string, nullable: The client code.
    - `currency` string: The 3-letter currency code associated with the client.
    - `notes` string, nullable: Notes associated with the client.
    - `emails` string[]: Email addresses used for invoicing the client.
    - `streetAddress` string, nullable: The street address of the client used for invoicing.
    - `invoiceDetailsSource` 'workspace' | 'custom' | 'business_unit': The source of invoice details for this client. Determines whether invoice settings are inherited from the workspace, the assigned business unit, or configured at the client level.
    - `invoiceSubject` string, nullable: The subject line used on invoices for this client.
    - `invoiceNotes` string, nullable: Notes included on invoices for this client.
    - `invoiceEmailSubject` string, nullable: The email subject line used when sending invoices for this client.
    - `invoiceEmailBody` string, nullable: The email body used when sending invoices for this client.
    - `isInternal` boolean: Indicates whether this is the workspace's internal client. This client is auto-created during workspace setup.
    - `recordStatusId` 'active' | 'archived': The record status of the client.
    - `createdAt` string, date-time: The timestamp when the object was created.
    - `modifiedAt` string, date-time: The timestamp when the object was last modified.
    - `owner` object, nullable: The member who owns this client.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the member.
    - `practice` object, nullable: The practice associated with this client.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the practice.
    - `industry` object, nullable: The industry associated with this client.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the industry.
    - `location` object, nullable: The location associated with this client.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the location.
    - `tags` object[]: The tags associated with this client.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the tag.
    - `invoicePaymentTerm` object, nullable: The payment term used for invoicing this client.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the payment term.
    - `salesRepresentative` object, nullable: The sales representative for this client.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the member.
    - `useWorkspaceInvoiceDetails` boolean: A legacy read-only field indicating whether the client uses workspace-level invoice details. Use `invoiceDetailsSource` instead.
    - `businessUnit` object, nullable: The business unit associated with this client.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the business unit.
    - `integrations` object[]: The accounting integration mappings for this client. Each entry ties the client to a record in an external accounting system. Empty when no integrations are configured.
      - `type` 'xero' | 'qbo': The accounting integration provider.
      - `connectionId` string: The Ruddr accounting connection ID associated with this mapping.
      - `externalId` string: The identifier of the corresponding record in the external accounting system.
  - `hasMore` boolean: Whether there are more results available after this page.

## Other responses

- `400`: 400

---

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