List employees

Production

https://api.simpra.app

GET

/employees

Retrieve a paginated list of employees

Request

Authorization

Add parameter in header

Simpra-Access-Token

Example:

Simpra-Access-Token: ********************

Query Params

Header Params

Responses

🟢200OK

application/json

Successfully retrieved employees

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.simpra.app/employees?page&per_page' \
--header 'Simpra-Access-Token: <api-key>' \
--header 'Content-Type: application\json'

Response Example

{
    "meta": {
        "has_next_page": true,
        "current_page": 0,
        "per_page_count": 0,
        "total_count": 0,
        "total_page": 0
    },
    "employees": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "first_name": "string",
            "last_name": "string",
            "phone_number": "string",
            "registration_no": "string",
            "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",
            "metafields": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "key": "string",
                    "value": "string",
                    "value_type": "string",
                    "updated_at": 0
                }
            ]
        }
    ]
}

Modified at 2025-09-10 09:28:46

Update menu item

List properties