accounts

List Account Entries

Changed on

List entries inside an account list.

Requires the account_lists:read scope on the API key.

get/v1/account-entries

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/account-entries
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number.

sizeinteger

Number of items per page.

sort_by'created_at' | 'updated_at' | 'name' | 'domain'

Field to sort by.

sort_order'asc' | 'desc'

Sort direction.

account_list_idstring uuid required

ID of the account list to scope the result to.

namestring nullable

Filter by company name (exact match).

domainstring nullable

Filter by company domain (exact match).

created_at_beforestring date-time nullable

Return entries created strictly before this timestamp.

created_at_afterstring date-time nullable

Return entries created strictly after this timestamp.

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