Retrieve Account Lists

Authorizations:
bearerAuth
query Parameters
folderIds
Array of strings

The IDs of the folders to retrieve account lists from.

Multiple ids can be sent by setting the parameter multiple times.

Example:

folderIds=abc123&folderIds=def789

pageToken
string

A page token, received from a previous call. Provide this token to retrieve the subsequent page.

To retrieve the first page, supply an empty page token.

When paginating, other parameters provided to the call must match the call that provided the page token.

Note: If a nextPageToken is returned by the endpoint, there may be more results regardless of whether or not the lists array is empty. Users must call this API with the returned nextPageToken until an empty nextPageToken is returned if they want to ensure that they have received all results.

pageSize
integer <int32>

The maximum size of the page results to return. Defaults to 100, max is 100.

Responses

Request samples

curl -i -X GET \
  'https://api.terminusplatform.com/accountLists/v2/accountLists?folderIds=string&pageToken=string&pageSize=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

Content type
application/json
{
  • "lists": [
    • {
      • "id": "string",
      • "displayName": "string",
      • "createTime": "2019-08-24T14:15:22Z",
      • "estimatedAccountsCount": "string",
      • "folderId": "string"
      }
    ],
  • "nextPageToken": "string"
}