Skip to main content
GET
/
clients
List clients
curl --request GET \
  --url https://www.ruddr.io/api/workspace/clients \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": "56deca22-a707-4148-a5f7-ea3ae6391d67",
      "key": "acme-corp",
      "name": "Acme Corp",
      "code": "ACM-001",
      "currency": "USD",
      "notes": "Key enterprise client.",
      "emails": [
        "billing@acmecorp.com"
      ],
      "streetAddress": "100 Market St, Suite 500",
      "invoiceDetailsSource": "custom",
      "invoiceSubject": "Invoice for professional services",
      "invoiceNotes": "Payment due within 30 days of receipt.",
      "invoiceEmailSubject": "Invoice from Ruddr",
      "invoiceEmailBody": "Please find your invoice attached.",
      "isInternal": false,
      "recordStatusId": "active",
      "createdAt": "2025-01-15T20:47:03.284Z",
      "practice": {
        "id": "b4cc2b99-3b3a-4b73-8f4e-8c1d7a94e5b0",
        "name": "Consulting"
      },
      "owner": {
        "id": "7c8f2e19-4d5a-4a3b-9c6d-2e8f1a0b3c4d",
        "name": "Jane Smith"
      },
      "invoicePaymentTerm": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Net 30"
      },
      "tags": [
        {
          "id": "d4e5f6a7-b8c9-0123-4567-89abcdef0123",
          "name": "Enterprise"
        }
      ],
      "salesRepresentative": {
        "id": "3a2b1c0d-4e5f-6789-0abc-def123456789",
        "name": "John Davis"
      },
      "useWorkspaceInvoiceDetails": false,
      "businessUnit": {
        "id": "e5f6a7b8-c9d0-1234-5678-9abcdef01234",
        "name": "North America"
      }
    }
  ],
  "hasMore": false
}
A person or organization using your services. All projects are tied to a client.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

startingAfter
string

A cursor ID (uuid) used to request the next page of results. If not provided, defaults to the first page of results.

endingBefore
string

A cursor ID (uuid) used to request the previous page of results. Is mutually exclusive with startingAfter.

limit
integer<int32>

The maximum number of results to be returned. Can be any number from 1 to 100. Defaults to 10, if not provided.

code
string

A client code to filter clients by code.

Response

200

results
object[]
hasMore
boolean

Whether there are more results available after this page.