Skip to main content
GET
/
clients
/
{id}
Get a client
curl --request GET \
  --url https://www.ruddr.io/api/workspace/clients/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
  }
}
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.

Path Parameters

id
string
required

The client uuid

Response

200

id
string

The unique identifier for the object.

key
string

The slug for the client, will be autogenerated from the name property if not provided.

name
string

The name of the client (max 255 chars).

code
string | null

The client code (max 255 characters).

currency
string

The 3-letter currency code associated with the client. Will default to the workspace setting if not supplied.

notes
string | null

Any notes associated with the client (max 5000 chars).

emails
string[]

A list of emails used for invoicing a client.

streetAddress
string | null

The street address of the client used for invoicing.

invoiceDetailsSource
enum<string>

If set to workspace (the default), the "paymentTermsId", "invoiceSubject", "invoiceNotes", "invoiceEmailSubject" and "invoiceEmailBody" will be used from the workspace settings.

Available options:
workspace,
custom,
business_unit
invoiceSubject
string | null

Subject that will get added to an invoice for this client (max 255 chars).

invoiceNotes
string | null

Notes that will get added to an invoice for this client (max 5000 chars).

invoiceEmailSubject
string | null

Email subject that will get added to an invoice for this client (max 255 chars).

invoiceEmailBody
string | null

Email body that will get added to an invoice for this client (max 5000 chars).

isInternal
boolean

Indicates whether this is the workspace's internal client. This client is auto-created during workspace setup.

recordStatusId
enum<string>

The status of the client record, can be used to indicate if the client is active or not. Defaults to active.

Available options:
active,
archived
createdAt
string<date-time>

The timestamp when the object was created.

practice
object

The practice associated with this client.

owner
object

The member who owns this client.

invoicePaymentTerm
object

The payment term used for invoicing this client.

tags
object[]

The tags associated with this client.

salesRepresentative
object

The member who is the sales representative for this client.

useWorkspaceInvoiceDetails
boolean

A legacy read-only field indicating whether the client uses workspace-level invoice details. Use invoiceDetailsSource instead.

businessUnit
object

The business unit associated with this client.