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": "4d7a1c3e-8f2b-4a90-b5d6-e9c1f0a82d47",
      "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",
      "owner": {
        "id": "e5c8a2f4-3d19-4b76-a0e7-9f1d6c4b28a3",
        "name": "Jane Smith"
      },
      "practice": {
        "id": "b82e4f61-a9c3-4d17-8e05-6f3b2a7d90c1",
        "name": "Consulting"
      },
      "tags": [
        {
          "id": "91d4e7a3-f826-4c10-b5a8-0e3d9c1f72b4",
          "name": "Enterprise"
        }
      ],
      "invoicePaymentTerm": {
        "id": "7a3f1d8e-c249-4b65-91d7-e0a4f8b2c603",
        "name": "Net 30"
      },
      "salesRepresentative": {
        "id": "c6f2b081-d47a-4e93-a8d5-3e1c7f9a204b",
        "name": "John Davis"
      },
      "useWorkspaceInvoiceDetails": false,
      "businessUnit": {
        "id": "2e8d5a7c-f314-4b09-96e1-a0c3d8f4b172",
        "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

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[]

The list of results for the current page.

hasMore
boolean

Whether there are more results available after this page.