List workspace participants

GET/v1/participants

Query parameters

filter[profileId] string

Filter participants by profileId. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.01JQ2T5Y5Q3R8W9N6M4K2H7P1B

filter[username] string

Filter participants by username. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.example

filter[email] string

Filter participants by email. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.example

filter[role] string

Filter participants by role. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.owner

select string

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

declared fields and relations only

ExampleprofileId,username

order string

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

repeat fields separated by commas

ExampleprofileId.asc,username.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: profileId, username, email, role.

Selectable: profileId, username, email, role.

Sortable: profileId, username, email, role.

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

data[].profileId string

ID of the related profile.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1B

data[].username string

username for this participant.

Exampleowner

data[].email string

Email address associated with the identity.

Exampleowner@example.com

data[].role string

Role assigned to the identity in the workspace.

Allowed values: "owner", "admin", "member"

Exampleowner

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 ↗