API Reference

/{connector_id}/list_accounts

post
https://example.com//list_accounts

Retrieve a list of accounts associated with the specified credentials. Response will include only active and suspended account.

Common use cases include:

  • Auditing connected accounts
  • Account discovery and synchronization

The request body allows for optional specification of custom attributes to include in the response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
auth
object

Authentication credentials, which can be one of several types.

credentials
array of objects
credentials
request
object
required

Request parameters for listing accounts.

boolean

Whether to include raw data in the response.

page
object

Pagination parameters for requests and responses.

settings
object

Connector-specific settings for the request.

These are settings that are shared across all capabilities.

Usually contain additional required configuration options not specified by the capability schema.

Response

Updated 11 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago