Clients

Get a client

get/clients/{id}

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/clients/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The client uuid

Response

200

idstring

The unique identifier for the object.

keystring

The URL-friendly slug for the client.

namestring

The name of the client.

codestring nullable

The client code.

currencystring

The 3-letter currency code associated with the client.

notesstring nullable

Notes associated with the client.

emailsstring[]

Email addresses used for invoicing the client.

streetAddressstring 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.

invoiceSubjectstring nullable

The subject line used on invoices for this client.

invoiceNotesstring nullable

Notes included on invoices for this client.

invoiceEmailSubjectstring nullable

The email subject line used when sending invoices for this client.

invoiceEmailBodystring nullable

The email body used when sending invoices for this client.

isInternalboolean

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.

createdAtstring date-time

The timestamp when the object was created.

modifiedAtstring date-time

The timestamp when the object was last modified.

useWorkspaceInvoiceDetailsboolean

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

Changes

No recorded changes to this operation across all 1 revision of this API.