Retrieve an Account List Preview

Retrieves a preview of the Accounts in the Account List. If there are additional Accounts in the list, use the returned URL to initiate a download of the additional Accounts.

Request
Security:
bearerAuth
path Parameters
listId
required
string

The Id of the Account List to return a preview of.

Responses
200

A successful response.

400

Returned when bad request is received.

401

Returned when a request is made without a valid API key

403

Returned when the given user does not have permissions on the requested resource

404

Returned when the given resource is not found

429

Returned when the given user has reached their API rate limits.

500

Returned when there is an unrecoverable error in the API. If you continue to receive this error, please contact support and include your terminus-request-id.

503

Returned when the service is currently unavailable.

get/accountLists/v2/accountLists/{listId}/accounts/preview
Request samples
curl -i -X GET \
  https://api.terminusplatform.com/accountLists/v2/accountLists/:listId/accounts/preview \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
    3 more
    429
    500
    503
application/json
{
  • "listId": "string",
  • "listName": "string",
  • "estimatedAccountsCount": "string",
  • "accounts": [
    • {
      • "id": "string",
      • "name": "string",
      • "crmOrgId": "string",
      • "crmType": "string"
      }
    ],
  • "moreResults": true,
  • "downloadResultsUrl": "string"
}