Skip to main content
There are three ways to fetch accounts:
For TypeScript, the GraphQL SDK gives you a fully typed client for these operations.
These operations require the following permissions:
  • tenant:read

Get accounts

Our API allows you to fetch accounts as a collection using the accounts query in GraphQL. This endpoint supports Pagination.
Query
Variables

Get account by ID

If you know the account’s ID in Plain you can use this method to fetch the account. Prefer upsert when you have the full details of the account.
Query
Variables

Search for accounts

The searchAccounts query lets you do a case-insensitive partial match on an account’s name as well as an exact match on its external ID. The search term must be at least 2 characters long.
Query
Variables