Accounts
Last updated
Was this helpful?
Last updated
Was this helpful?
Get an account by its ID or external ID
The ID or external ID of the account to fetch.
Delete an existing account
The ID or external ID of the account to delete.
Get a list of accounts
The cursor to use for pagination.
The number of accounts to fetch. Defaults to 100. Must be greater than 0 and less than 1000.
Create a new account
Deprecated. Please use Domains and PrimaryDomain instead.
The domains of the account, without any leading scheme, for example stripe.com. Must specify one domain as primary.
The logo URL of the account. Must be a square .png, .jpg or .jpeg.
The name of the account.
Must be in the list of domains. If there are any domains, there must be exactly one primary domain.
An array of strings to use as tags on this account. If provided, the accounts tags will be updated to the given tags.
Update an existing account
The ID or external ID of the account to update.
Domains of the account. Must specify one domain as primary.
The name of the account.
The ID of the owner of the account.
Must be in the list of domains. If there are any domains, there must be exactly one primary domain.
An array of strings to use as tags on this account. If provided, the accounts tags will be updated to the given tags.
Currently, the following fields are filterable for accounts:
domains. Allowed operators: contains
, does_not_contain
, in
, not_in
tags. Allowed operators: contains
, does_not_contain
, in
, not_in
name. Allowed operators: equals
, in
, not_in
custom fields (pass in the slug of the custom field)
The cursor to use for pagination.
The number of accounts to fetch. Defaults to 100. Must be greater than 0 and less than 1000.