Skip to main content
GET
List entities by type

Query Parameters

entity_type
string
required

Entity type to filter by (e.g. Customer)

limit
integer
default:100
Required range: 1 <= x <= 500
offset
integer
default:0
Required range: x >= 0
page
integer | null

Page number (1-based). Overrides offset.

Required range: x >= 1
page_size
integer | null

Items per page.

Required range: 1 <= x <= 500

Response

Successful Response

Response for GET /entities.

results
EntityProfileResponse · object[]
required
count
integer
required
total
integer | null
page
integer | null
page_size
integer | null