Get a requirement

Retrieves a single requirement instance by ID.

Add ?expand[]=Configuration to inline a redacted summary of the resource configurationId addresses, instead of deriving its collection from type and issuing a second call.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the requirement instance

Query Params
expand
array of strings, unique

Inline related resources on a single PayeeRequirement read. Supported value is Configuration — a redacted summary of the resource that configurationId addresses (the requirement DEFINITION's own backing template/configuration — distinct from dataSourceId, this INSTANCE's own backing resource). Unsupported values return 422 instead of being silently ignored. Expansions are not available on list rows.

The summary is a deliberate SUBSET of the full configuration resource: payer-only fields (template-editing links, owner/viewer lists, the payer's own annotations) are never surfaced here. Requesting Configuration is never an error: the key is simply omitted when there is nothing to inline — a requirement type with no configuration, a null configurationId, or a lookup that cannot resolve one. A supported value that resolves nothing is a 200 with the key absent; only an unsupported value is a 422.

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