FruxonDocs
ApiIntegration config sandbox

List simulated entities in the sandbox.

Returns simulated entities scoped to the given integration config. Optionally filter by entity type (e.g. "user", "channel") and/or by scope (a tenant-defined partition, for example a workspace id). Returns an empty list if no entities match.

GET
/v1/tenants/{tenant}/integrations/{integration}/configs/{config}/sandbox/entities

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

config*string

The integration config id whose sandbox to query.

Formatuuid
tenant*string

The tenant identifier

integration*string

The integration identifier

Query Parameters

entityType?string

Optional entity type filter (exact match).

scope?string

Optional scope filter (exact match).

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/integrations/string/configs/497f6eca-6276-4993-bfeb-53cbbbba6f08/sandbox/entities"
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "entityType": "string",
    "scope": "string",
    "entityId": "string",
    "payload": "string",
    "tombstoned": false,
    "createdAt": 0,
    "modifiedAt": 0
  }
]
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}