List requirement definitions

get

https://api.wingspan.app/v3/onboarding/requirement-definitions

Returns a paginated list of requirement definitions. Filterable by type, externalId, dataSourceId and status — the last two answer "which definitions point at this configuration" and "is this definition Active or Inactive". pagination.totalSize is the count after applying the supplied filters, so callers can request Active and Inactive tab counts.

Expansion is not available on list rows; use the single read for ?expand[]=DataSource.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

object

Pagination query parameters. Serializes as page[size] and page[token].

filter

object

Filters use deep-object query parameters with the IN-style array operator, for example filter[type][in][]=Signature. Every filter matches ANY of the supplied values. anyOf is accepted as an equivalent spelling of in. type additionally accepts notIn (spelled noneOf equivalently) to exclude values.

sort

object

Sort by sort[updatedAt]=asc|desc.

Headers

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Requirement definitions list

400Malformed request syntax

401Unauthenticated

403Forbidden

422Validation error