v1
latestOpenAPI 3.0.02026-07-2691259477.2 KBRetrieve a list of all individual (and/or corporate) accounts
Query parameters
Search term to filter accounts by
Fields to search in accounts using search terms
A way to filter accounts based on certain criteria.
Syntax:
• Colon (:): Assigns a value to an attribute (e.g., key:value).
• Pipe (|): Logical OR separator for multiple values of the same attribute (e.g., key:val1|val2).
• Comma (,): Logical AND separator between different attribute filters (e.g., key1:val,key2:val).
Example: $filter=profiles.solutionName:'Test1'|'Test2',identity.firstName:'test' will return records matching solution name('Test1' OR 'Test2') AND having the first name 'test'.
Page size — number of accounts to return per request
Which field to order the results by. Allowed values here are createdAt (date account was created) or type (account type)
Restrict the returned fields to only those specified. Allowed fields: createdAt, type, id, externalAccountId, status, profiles
Sort order: ascending (asc) or descending (desc)
A token for retrieving the next or previous page of results in pagination
Whether to paginate forwards (next) or backwards (prev)