List and search accounts for an account group

get

https://api.sandbox.tapico.io/v1/authorising-users/{authorisingUserId}/account-groups/{accountGroupId}/accounts

Get details of the accounts associated with the specified account group.

Path Params

authorisingUserId

uuid

required

Authorising User ID.

accountGroupId

uuid

required

Account Group ID.

Query Params

array of uuids

A CSV of specific resource IDs to retrieve.

string

length ≤ 30

Search for entities based on search term.

externalId

string

Filter Account results by the source system primary entity identifier.

cursor

string

Each response payload may contain a nextCursor in the metadata, which is a pointer to the next set of results when more results are available.

Set this query parameter to access the next page of results.

limit

integer

1 to 100

Defaults to 20

The numbers of items to return.

sort

string

enum

Default sorting, by createdDateTime or updatedDateTime property.

Allowed:

expand

array of strings

Account expandable fields.

expand

Headers

region

string

enum

Specifies the Region for the request. When specified, this must match the region that the application access token was generated for.

For more information about regions see https://docs.tapico.io/docs/regions

Allowed:

Responses

Language

Credentials

Bearer

jwt

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200success response.

400Bad Request.

401The credentials used are not recognised.

403Forbidden.

422Request parameter validation error.

429Too many requests sent in quick succession.

500Internal Server Error.