List my entities

GET

/my-entities

Returns a paginated list of all entities the authenticated identity has access to, the same set returned by GET /entities, but with an additional membership object on each entity describing the caller's own relationship to it (ownership, role, and permissions).

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 caller has a resource-access record are returned — the list is scoped to the caller's own entities. This endpoint only accepts JWT (user session) authentication, since membership is always computed relative to the calling identity.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Query Params

Responses

🟢200

application/json

A page of the caller's entities, each annotated with the caller's membership, returned successfully.

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Page containing an owned entity and a team-member entity

{
    "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"
                }
            ],
            "membership": {
                "is_owner": true,
                "role": null,
                "role_name": "Owner",
                "permissions": [
                    "*"
                ]
            }
        },
        {
            "id": "01JDEF9876543210ABCDEFGHIJ",
            "parent_id": null,
            "name": "Beta Traders Ltd",
            "client_reference": "ent-ng-002",
            "client_label": null,
            "type": "business",
            "category": "wholesale",
            "email": "hello@betatraders.ng",
            "mobilenumber": "+2348098765432",
            "country": "NG",
            "status": "approved",
            "identity_id": "01JIDENT765432109ABCDEFGH",
            "entity_logo": null,
            "client_meta": null,
            "sandboxes": [
                {
                    "id": "01JSBX9876543210ABCDEFGHIJ",
                    "name": "Default",
                    "is_default": true,
                    "activation_status": "completed"
                }
            ],
            "membership": {
                "is_owner": false,
                "role": "finance",
                "role_name": "Finance",
                "permissions": [
                    "can_view_entity",
                    "can_list_accounts",
                    "can_list_transactions"
                ]
            }
        }
    ],
    "meta": {
        "pagination": {
            "cursor": "01JXYZ9876543210ZYXWVUTSRQ",
            "has_more": true
        }
    }
}

Modified at 2026-09-30 00:29:45

Retrieve one of your entities, including your membership

Create a counterparty