Retrieve an entity

GET

/entities/{id}

Fetches a single entity by its unique identifier. The authenticated identity must have an active resource-access record for the entity — either a wildcard * permission or the specific can_view_entity ACL flag. Attempting to fetch an entity you do not have access to returns a 403.

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 ********************

Path Params

Responses

🟢200

application/json

The entity was found and returned successfully.

Bodyapplication/json

🟠401

🟠403

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/entities/01JABC1234567890ABCDEFGHIJ' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "message": "Entity 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",
        "entity_logo": null,
        "category": "retail",
        "email": "contact@acmecorp.ng",
        "mobilenumber": "+2348012345678",
        "country": "NG",
        "status": "approved",
        "identity_id": "01JIDENT234567890ABCDEFGHI",
        "client_meta": {
            "crm_id": "crm-8821"
        }
    }
}

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

Update an entity

Set the selected entity