Skip to main content
GET
Get a client

Authorizations

Authorization
string
header
required

Workspace credential issued from the automation console at /automation. Send it as Authorization: Bearer vq_ws_.... This is NOT a Data API key: a vq_key_ credential is refused here and names the other product in the error.

Path Parameters

clientId
string
required

cli_ identifier of the client. Take it from GET /v1/clients.

Response

Successful Response

A client as this API publishes it.

id
string
required

Public identifier, cli_ followed by 32 hex characters.

Example:

"cli_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

name
string
required

The client's display name, as the customer entered it.

Example:

"Acme Corporation"

email
string | null

Primary contact email address.

Example:

"counsel@acme.example"

phone
string | null

Primary contact phone number, stored as written and not normalized.

Example:

"+1 415 555 0142"

address
string | null

Street address, one free-text line.

Example:

"500 Howard Street"

city
string | null

City or town.

Example:

"San Francisco"

state
string | null

State, province or region.

Example:

"CA"

zipCode
string | null

Postal or ZIP code.

Example:

"94105"

country
string | null

Country as free text, NOT an ISO code. matters.country is a two-letter code; this column is not.

Example:

"US"

clientType
string | null

What kind of client this is. Usually one of individual, organization or corporation, but published as a plain string because the column's CHECK is the only thing constraining it. Do not branch on it without a fallback.

Example:

"organization"

taxId
string | null

Tax or company registration number.

Example:

"94-3211110"

notes
string | null

Free-text notes the customer keeps against this client.

Example:

"Primary contact is in-house counsel, not procurement."

metadata
Metadata · object

Arbitrary JSON the customer stores against the client. Vaquill never reads it.

createdAt
string<date-time> | null

When the client was created (RFC 3339). Absent on a small number of rows that predate the column default.

Example:

"2026-08-19T14:32:10Z"

updatedAt
string<date-time> | null

When the client was last modified (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

Last modified on August 23, 2026