Swagger Petstore - OpenAPI 3.0
GET/v1/accounts/{account}/persons

List all persons associated with an account

Lists all people associated with the account's legal entity, sorted by creation date with the most recent appearing first. Use pagination parameters to navigate through results and the relationship filter to scope by role such as owner, director, or executive.

6 parameters
accountstringrequired

The unique identifier of the account whose associated people to list.

ending_beforestringoptional

A cursor for pagination. Pass an object ID to fetch the previous page of results.

expandarray<string>optional

Specifies which fields in the response should be expanded.

limitintegeroptional

Maximum number of objects to return. Must be between 1 and 100. Defaults to 10 when omitted.

relationshipobjectoptional

Filter results by the person's relationship to the account, such as owner, director, executive, representative, authorizer, or legal_guardian.

starting_afterstringoptional

A cursor for pagination. Pass an object ID to fetch the next page of results.

2 status codes
200Returns a list object containing an array of person objects, pagination metadata, and a URL for the list.
dataarray<Person>required
has_morebooleanrequired

True if this list has another page of items after this one that can be fetched.

objectstringrequired

String representing the object's type. Objects of the same type share the same value. Always has the value list.

Allowed:list
urlstringrequired

The URL where this list can be accessed.

defaultError response.
errorobjectrequired

Error handling

account must identify an existing account. The limit parameter must be between 1 and 100; values outside this range are rejected. Use starting_after and ending_before for cursor-based pagination.