Gets all system entities

Sandbox server

https://api-sandbox.e-schooling.com

GET

/api/entities

Method that lists all entities in the system

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

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

Query Params

Header Params

Responses

🟢200OK

application/json

Body

🟠401Unauthorized

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api-sandbox.e-schooling.com/api/entities' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "entities": [
        {
            "entity_id": "6803aea8-295d-44bb-ace0-2c4979da6bc9",
            "ative": true,
            "email": "jonhdoe@email.com",
            "name": "John Doe",
            "gender": "Male",
            "photobase64": "",
            "birth_date": "2025-04-09",
            "naturality": "England",
            "nationality": "England",
            "marital_status": "single",
            "deceased": false,
            "addresses": [
                {
                    "address": "Street 1",
                    "address2": "House 30",
                    "zone_code": "1111",
                    "postal_code": "5555",
                    "city": "London",
                    "country": "England"
                }
            ],
            "contacts": [
                {
                    "contact": "1111111111",
                    "contact_type_name": "Phone"
                },
                {
                    "contact": "johndoe@email.com",
                    "contact_type_name": "Email"
                }
            ],
            "documents": [
                {
                    "init_date": "2025-04-09",
                    "end_date": "2025-04-09",
                    "identification_document_value": "999988888",
                    "identification_document_type_name": "Passport"
                },
                {
                    "init_date": "2025-04-09",
                    "end_date": "2025-04-09",
                    "identification_document_value": "123456789",
                    "identification_document_type_name": "NationalID"
                }
            ],
            "bankAccounts": [
                {
                    "back_account_number": "PT5012345678912345678912",
                    "country_name": "PORTUGAL",
                    "entity_bank_account_type": "IBAN"
                }
            ]
        },
        {
            "entity_id": "782c709e-b7b8-423c-b707-014e659ca23b",
            "ative": true,
            "email": "janeoe@email.com",
            "name": "Jane Doe",
            "gender": "Female",
            "photobase64": "",
            "birth_date": "2025-04-09",
            "naturality": "England",
            "nationality": "England",
            "marital_status": "single",
            "deceased": false,
            "addresses": [
                {
                    "address": "Street 2",
                    "address2": "House 40",
                    "zone_code": "1111",
                    "postal_code": "6666",
                    "city": "London",
                    "country": "England"
                }
            ],
            "contacts": [
                {
                    "contact": "999999999",
                    "contact_type_name": "Phone"
                },
                {
                    "contact": "janedoe@email.com",
                    "contact_type_name": "Email"
                }
            ],
            "documents": [
                {
                    "init_date": "2025-04-09",
                    "end_date": "2025-04-09",
                    "identification_document_value": "9999111111",
                    "identification_document_type_name": "Passport"
                },
                {
                    "init_date": "2025-04-09",
                    "end_date": "2025-04-09",
                    "identification_document_value": "987654321",
                    "identification_document_type_name": "NationalID"
                }
            ],
            "bank_accounts": [
                {
                    "back_account_number": "GB2921212121212121212122",
                    "country_name": "PORTUGAL",
                    "entity_bank_account_type": "IBAN"
                }
            ]
        }
    ],
    "page": 1,
    "items_per_page": 2
}

Modified at 2025-04-09 14:10:01

Defaults

Gets a entity from its id