Skip to main content
GET
List all accounts

Authorizations

X-Api-Key
string
header
required

API key for authentication. Access https://console.beltic.com/ to obtain your API key.

Query Parameters

page[size]
string

Number of items per page (default: 15)

Pattern: ^\d+$
Example:

"15"

page[after]
string

Cursor for fetching items after this point

Example:

"eyJ2YWx1ZXMiOnsiY3JlYXRlZF9hdCI6IjIwMjUtMTAtMjJUMjI6MTM6NDguMTQ5WiJ9LCJpZCI6IjNkZjk3MWQwLWNkNTYtNDAwNi05YmM0LTFjYmMzMjc1OWI2ZiJ9"

page[before]
string

Cursor for fetching items before this point

Example:

"eyJ2YWx1ZXMiOnsiY3JlYXRlZF9hdCI6IjIwMjUtMTAtMjJUMjI6MTM6NDguMTQ5WiJ9LCJpZCI6IjNkZjk3MWQwLWNkNTYtNDAwNi05YmM0LTFjYmMzMjc1OWI2ZiJ9"

page[total]
enum<string>

Include total count in response (may impact performance)

Available options:
true,
false
Example:

"true"

status
enum<string>

Filter accounts by status

Available options:
active,
inactive,
suspended,
pending
Example:

"active"

entity_type
enum<string>

Filter accounts by entity type

Available options:
person,
business
Example:

"person"

Response

Successfully retrieved accounts

data
object[]
required
meta
object
required