API Reference
Privacy policy

List all available entity of an entity module

get
https://api.staging.antavo.com/entities//

This endpoint lists all available entity items within the specified entity module. This interaction is customer-independent.

Path Params
string
required

Name of the entity module e.g., rewards, accounts, custom (for custom entities).

string
required

The entity's unique ID - typically the singular form of the entity module name.

Query Params
integer
Defaults to 0

Offsets the starting number of entity items to return. This is used in pagination in conjunction with the limit query.

integer
Defaults to 100

Limits the number of entity items to be returned in one response. Other values are accessible by pagination made accessible via the offset.

additional queries
object

Custom queries can be added here.

Responses

Updated over 1 year ago

Did this page help you?
Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?