API ReferenceSimulations

List Simulation Customers

View as Markdown

List the customers created inside a simulation, each with their simulated subscriptions.

Powers the “Simulation objects” section of the simulation detail page. Only objects carrying this simulation’s id are returned (the data silo).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

external_idstringRequired

Query parameters

limitintegerOptional1-100Defaults to 50
Number of items per page
offsetintegerOptional>=0Defaults to 0
Number of items to skip
filterstringOptionalDefaults to {}

Filter conditions as key-value pairs or advanced filter objects (JSON string)

sortBystring or nullOptional
Field to sort by
sortOrderintegerOptionalDefaults to -1

Sort order: 1 for ascending, -1 for descending

searchstring or nullOptional

Keyword-based search across multiple fields

Response

Successful Response
itemslist of objects
totalinteger
has_moreboolean

Errors

422
Unprocessable Entity Error