Get a payee engagement

Retrieve one engagement on this Payee relationship, whether the payer or the payee created it. Supports ?expand=Requirements to inline the attached Requirement instances, each stamped with blockingMode. Changes on this route apply to engagements the payer created; a change to a payee-created engagement returns 403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[A-Za-z0-9_.]{22,80}$
string
required

Payee engagement ID (concrete assignment)

Query Params
expand
array of strings, unique

Inline related resources on a single PayeeEngagement read (the payer-side flat path and the payee-nested path). Requirements inlines the Requirement instances attached to this engagement, each stamped with blockingMode, and is available to the payer seat. WorkDefinitions inlines the WorkDefinitions attached to the underlying Engagement template and is available to both seats — the template is payer-owned, so this is the payee's only read path to the attribute shape a WorkItem must satisfy. Unsupported values return 422 instead of being silently ignored. Use this expansion for the per-engagement view; the retired /engagements/{id}/requirements collection is not a V3 route. For filtered or paginated reads, use /v3/onboarding/payee-requirements?filter[payeeEngagementId][in][]=...; those standalone rows intentionally omit the engagement-contextual blockingMode. Expansions are not available on list/search rows.

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