Finance

List client contacts

List client contacts.

GET/v1/clients/{clientId}/contacts

Path parameters

clientId string required

An opaque client resource identifier.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1C

Query parameters

filter[id] string

Filter clients by id. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.01JQ2T5Y5Q3R8W9N6M4K2H7P1A
filter[clientId] string

Filter clients by clientId. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.01JQ2T5Y5Q3R8W9N6M4K2H7P1C
filter[vendorId] string

Filter clients by vendorId. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.01JQ2T5Y5Q3R8W9N6M4K2H7P1C
filter[name] string

Filter clients by name. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.example
filter[description] string

Filter clients by description. Use operator.value syntax.

eq, neq, gt, gte, lt, lte, in, is operators

Exampleeq.example
filter[bank] string

Filter clients by bank. Use operator.value syntax.

eq, neq, gt, gte, lt, lte, in, is operators

Exampleeq.example
filter[iban] string

Filter clients by iban. Use operator.value syntax.

eq, neq, gt, gte, lt, lte, in, is operators

Exampleeq.example
filter[tags] string

Filter clients by tags. Use operator.value syntax.

in, is operators

Examplein.(example)
filter[createdAt] string

Filter clients by createdAt. Use operator.value syntax.

eq, neq, gt, gte, lt, lte, is operators

Exampleeq.2026-01-15T12:00:00Z
filter[updatedAt] string

Filter clients by updatedAt. Use operator.value syntax.

eq, neq, gt, gte, lt, lte, is operators

Exampleeq.2026-01-15T12:00:00Z
select string

Comma-separated fields. Select a declared relation with relation(field,field).

declared fields and relations only

Exampleid,clientId
order string

Order by field.asc or field.desc. Repeat fields with commas.

repeat fields separated by commas

Exampleid.asc,clientId.asc
limit integer

Maximum records returned. Defaults to 25.

1 to 1000

Example25
cursor string

Opaque continuation cursor returned by the previous page.

Exampleopaque-cursor
count string

Request an exact count. This may cost more than a normal page.

exact

Exampleexact
Query options

Use filter, select, order, limit, cursor, count, search. The default limit is 25; the maximum is 1000.

Filterable: id, clientId, vendorId, name, description, bank, iban, tags, createdAt, updatedAt.

Selectable: id, clientId, vendorId, name, description, email, phone, website, position, bank, iban, tags, createdAt, updatedAt.

Sortable: id, clientId, vendorId, name, description, bank, iban, createdAt, updatedAt.

Errors: invalid_input, query_invalid, unauthenticated, not_found, forbidden, plan_limit, conflict, rate_limited, request_quota, unavailable, internal_error.

Headers

authorization string required

Bearer workspace API key.

ExampleBearer $NQD_API_KEY
workspace-id string required

Workspace scope for the request. Required for workspace operations and must belong to the authenticated identity.

Minimum length: 1 character. · Maximum length: 128 characters.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1A

Response

200Success

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
data object[]

Returned records. Collections and batches use an array; single records use an object.

ShowHide 14 properties
data[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1C
data[].clientId string

Optional client relationship for this contact. A contact may also reference a vendor; when both are provided they must resolve to the same party. A null clientId alone does not mean workspace ownership when vendorId is set.

Examplenull
data[].vendorId string

Optional vendor relationship for this contact. A contact may also reference a client; when both are provided they must resolve to the same party. Both relationship IDs null means the current workspace owns the contact.

Examplenull
data[].name string

Display name of the record.

ExampleNQD record
data[].description string

Optional human-readable description of the record.

ExampleConsulting services for January 2026
data[].email string[]

Email address associated with the identity.

Example1 item
data[].phone string[]

phone for this client.

Example1 item
data[].website string[]

website for this client.

Example1 item
data[].position string[]

position for this client.

Example1 item
data[].bank string

bank for this client.

ExampleNQD Bank
data[].iban string

iban for this client.

ExampleSA0380000000608010167519
data[].tags string[]

Tags assigned to the record.

Example1 item
data[].createdAt string

ISO 8601 timestamp for the authored or payment event. Recurring records preserve their scheduled occurrence.

Example2026-01-15T12:00:00.000Z
data[].updatedAt string

Timestamp used for stale-edit protection. Preserve the server value when updating.

Example2026-01-15T12:00:00.000Z
page object

Pagination metadata for the returned records, or the current page number when this endpoint uses numbered pages.

ShowHide 4 properties
page.limit number

Maximum number of records to return for this page.

Example1
page.hasMore boolean

Whether another page is available.

Examplefalse
page.nextCursor string

Opaque cursor for the next page, or null when there is no next page.

Examplenull
page.total number nullable

Total number of records that match the request.

Example1

Possible errors

400 Invalid request

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
error object

Error details returned for a failed request.

ShowHide 4 properties
error.code string

Stable machine-readable error or resource code.

Exampleinvalid_input
error.message string

Human-readable explanation of the result or error.

ExampleThe request could not be validated.
error.requestId string

Correlation identifier for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
error.details object nullable

Additional structured details about the result or error.

ShowHide 1 property
error.details.issues object[]

Structured field issues returned when request validation fails.

ShowHide 3 properties
error.details.issues[].path string | number[]

Field path where the validation issue occurred.

One of: string alternative 1, number alternative 2

Example0 items
error.details.issues[].reason string

Machine-readable reason for the validation issue.

Allowed values: "expected_type", "required", "unexpected_property", "invalid_value", "invalid_json", "invalid_query", "unsupported_media_type", "body_too_large", "body_timeout", "conflicting_scope", "missing_header", "concurrency_required", "invalid_resource_id", "invalid_request"

Exampleinvalid_request
error.details.issues[].code string nullable

Stable machine-readable error or resource code.

Exampleinvalid_input
Example 400 response
{
  "error": {
    "code": "invalid_input",
    "message": "The request could not be validated.",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "details": {
      "issues": [
        {
          "path": [],
          "reason": "invalid_request"
        }
      ]
    }
  }
}
View raw OpenAPI operation

Use the machine-readable contract for client generation and payload validation.

Open OpenAPI contract ↗