Get Tasks Tasks
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Query Parameters
The target person identifier. When supplied, it takes precedence over the caller's bp_person claim. The target is subject to authorization; authorization denials return 404 to avoid disclosing whether the person exists.
Optional task type filter. When supplied, only tasks matching one of the provided types are returned. The listed UPPER_SNAKE_CASE values are canonical for requests and responses. PascalCase identifiers are accepted as noncanonical backward-compatible inputs (for example, RepaymentsDue). Values outside the recognized task types return 400. Repeatable: ?task_type=REPAYMENTS_DUE&task_type=RECEIPTS_NEEDED. Omit to return all visible task types.
Show child attributes
Response
OK
Response Attributes
Tasks in display order: display priority descending, then metadata.created_utc ascending for tasks that share a priority.
Show child attributes
Bad Request — request parameters are invalid, or neither person_id nor a valid bp_person claim resolves the target person.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized — authentication failed, or a Consumer or BusinessContact token does not include bp_business.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Not Found — the target person was not found or the caller is not authorized to access the target person. This response intentionally avoids disclosing whether the target person exists.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Internal Server Error
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Service Unavailable — the PersonAuth dependency was unavailable while authorizing the target person. Retry with exponential back-off.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unexpected error
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Base URL
Production:
Sandbox: