List requirements

Returns a paginated list of requirement instances. Supports filtering by status, type, payer, payee, engagement, definition, backing-resource sub-state, expiration state, and creation/expiry date ranges. The selected X-Wingspan-Account is the caller's own Payee account, or the Payer account when an explicit foreign payeeId review filter is supplied.

There is no payeeEngagementId != null idiom for separating active from archived requirements. Detaching a requirement from its last engagement sets its status to Inactive, so active is filter[status][notIn][]=Inactive and archived is filter[status][in][]=Inactive. Note that Inactive is a superset of "detached" — a cancelled monitor is Inactive while still attached to its engagement.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
page
object

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

filter
object

Filters use deep-object query parameters. Most are IN-style array operators, for example filter[status][in][]=PendingCompletion, matching ANY of the supplied values; anyOf is accepted as an equivalent spelling of in. status and type additionally accept notIn (spelled noneOf equivalently) to exclude values, and createdAt and expiresAt accept gte/lte date bounds. Every filter is ANDed with the others.

Headers
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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json