Read profile preferences

GET/v1/profile/preferences

Query parameters

filter[scope] string

Filter profile-preferences by scope. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.example

filter[schemaVersion] string

Filter profile-preferences by schemaVersion. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.1

filter[revision] string

Filter profile-preferences by revision. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.1

filter[updatedAt] string

Filter profile-preferences 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

Examplescope,preferences

order string

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

repeat fields separated by commas

Examplescope.asc,schemaVersion.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: scope, schemaVersion, revision, updatedAt.

Selectable: scope, preferences, schemaVersion, revision, updatedAt.

Sortable: scope, schemaVersion, revision, 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 access token returned by the authentication service.

ExampleBearer $NQD_ACCESS_TOKEN

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 5 properties

data[].scope string

scope for this profile preference.

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

ExampleConsulting services

data[].preferences object

preferences for this profile preference.

data[].schemaVersion number

schema version for this profile preference.

Example100

data[].revision number

revision for this profile preference.

Example100

data[].updatedAt string nullable

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

{
  "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 ↗