List integration logs

GET/v1/logs

Query parameters

filter[id] string

Filter logs by id. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.01JQ2T5Y5Q3R8W9N6M4K2H7P1A

filter[action] string

Filter logs by action. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.example

filter[operationId] string

Filter logs by operationId. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.example

filter[occurredAt] string

Filter logs by occurredAt. Use operator.value syntax.

eq, neq, in, 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,action

order string

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

repeat fields separated by commas

Exampleid.asc,action.asc

limit integer

Maximum records returned. Defaults to 25.

1 to 250

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

Filterable: id, action, operationId, occurredAt.

Selectable: id, action, recordId, actorId, operationId, occurredAt.

Sortable: id, action, operationId, occurredAt.

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

Use the returned nextCursor for the next page. Do not combine cursor with before, beforeId, or beforeAttempt.

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[]

Integration log value retained for delivery and debugging.

ShowHide 6 properties

data[].id string

Integration log value retained for delivery and debugging.

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

Example01JQ2T5Y5Q3R8W9N6M4K2H7P2A

data[].action string

Integration log value retained for delivery and debugging.

Maximum length: 128 characters.

ExampleConsulting services

data[].recordId string

Integration log value retained for delivery and debugging.

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

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1P

data[].actorId string

Integration log value retained for delivery and debugging.

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

Examplenull

data[].operationId string

Integration log value retained for delivery and debugging.

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

Exampleinvoices.upsert

data[].occurredAt string

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

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

Integration log value retained for delivery and debugging.

Examplenull

page.total number nullable

Integration log value retained for delivery and debugging.

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

Integration log value retained for delivery and debugging.

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

Integration log value retained for delivery and debugging.

ShowHide 1 property

error.details.issues object[]

Structured field issues returned when request validation fails.

ShowHide 3 properties

error.details.issues[].path string | number[]

Integration log value retained for delivery and debugging.

One of: string alternative 1, number alternative 2

Example0 items

error.details.issues[].reason string

Integration log value retained for delivery and debugging.

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 ↗