accounts

List Accounts

Changed on

List accounts attached to the authenticated organization.

Requires the accounts:read scope on the API key.

get/v1/accounts

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/accounts
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number.

sizeinteger

Number of items per page.

sort_bystring nullable

Field to sort by.

sort_order'asc' | 'desc'

Sort direction.

domainstring nullable

Filter by primary company domain (case-insensitive exact match).

namestring nullable

Filter by company name (case-insensitive substring match).

Response

Successful Response

total_countinteger required

Total number of records matching the query.

total_pagesinteger required

Total number of pages.

has_moreboolean required

Whether more pages remain after the current one.

Changes