List entities

GET

/entities

Returns a paginated list of all entities the authenticated identity has access to. Results are ordered newest-first by creation date. Use the cursor returned in each response to fetch the next page; when has_more is false you have reached the end of the list.

Only entities for which the identity has a resource-access record are returned — the list is scoped to the caller's own entities.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

A page of entities returned successfully.

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location '/entities?cursor=01JXYZ1234567890ABCDEFGHIJ&limit=25' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Page with more results available

{
    "message": "Entities retrieved successfully",
    "status": "success",
    "data": [
        {
            "id": "01JABC1234567890ABCDEFGHIJ",
            "parent_id": null,
            "name": "Acme Corp Nigeria",
            "client_reference": "ent-ng-001",
            "client_label": "Acme NG",
            "type": "business",
            "category": "retail",
            "email": "contact@acmecorp.ng",
            "mobilenumber": "+2348012345678",
            "country": "NG",
            "status": "approved",
            "identity_id": "01JIDENT234567890ABCDEFGHI",
            "entity_logo": null,
            "client_meta": null,
            "sandboxes": [
                {
                    "id": "01JSBX1234567890ABCDEFGHIJ",
                    "name": "Default",
                    "is_default": true,
                    "activation_status": "completed"
                }
            ]
        }
    ],
    "meta": {
        "pagination": {
            "cursor": "01JXYZ9876543210ZYXWVUTSRQ",
            "has_more": true
        }
    }
}

Modified at 2026-09-28 09:43:27

Create an entity

Close an entity