List Additional Person Applications
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Query Parameters
Role to use when associating the Person Application with the Account. Filterable.
Status of the additional person application. One of approved
, error
, pending
, processing
, rejected
, manual_review
. Filterable.
Pagination cursor, value is the object ID.
Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.
x >= 1
Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).
Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).
Response
A dictionary with a data
property that contains a list of up to page_size
additional-person-application elements, starting after the additional-person-application described by page_cursor
. If no more additional-person-applications are available, the resulting list will be empty.
The response is of type object
.