ahlan hamad

Sandbox & testing

You build and test against a sandbox company of your own that holds only generated data. The Partner API isn't open to everyone yet: request API access and we'll get back to you — the steps below apply once your access is on.

Create a sandbox once your access is on

  1. Sign in to Ahlan Hamad, or create a free account.
  2. Open Integrations → API keys and press Create sandbox company.
  3. Pick the country: Kuwait, Saudi Arabia, UAE, Qatar, Bahrain or Oman. Currency, timezone, weekend and social-insurance rules follow the country you pick.
  4. You become the sandbox's CEO by membership only — your current company does not change. Use Switch to sandbox when you want to work in it.
  5. In the sandbox, create an API key and choose its scopes. It starts with ah_test_ and is shown once — copy it straight away.
curl https://actions.ahlanhamad.com/v1/company \
  -H "Authorization: Bearer ah_test_…"

Each user can have one sandbox company. Resetting or deleting a sandbox is not available yet.

What the sandbox contains

Staff numberJob titleDepartmentNationalityemployment_type
SBX-001General ManagerManagementNational of the sandbox countryfull_time
SBX-002Finance ManagerFinanceNational of the sandbox countryfull_time
SBX-003HR OfficerHuman ResourcesNational of the sandbox countryfull_time
SBX-004Store ManagerRetailIndianfull_time
SBX-005CashierRetailFilipinofull_time
SBX-006CashierRetailEgyptianfull_time
SBX-007CashierRetailIndianpart_time
SBX-008Stock AssociateRetailFilipinofull_time
SBX-009DriverOperationsPakistanifull_time
SBX-010AccountantFinanceJordaniancontract

How test keys behave

What you can call today

Generated from openapi.yaml: the operations that are live now, and the ones published in the contract that have not shipped yet.

OperationReleaseStatus
GET /v1/companyv1.0Live
GET /v1/employeesv1.0Live
POST /v1/employeesv1.4Live
GET /v1/employees/{employee_id}v1.0Live
PATCH /v1/employees/{employee_id}v1.4Live
GET /v1/payroll-runsv1.0Live
GET /v1/payroll-runs/{payroll_run_id}v1.0Live
POST /v1/attendance/eventsv1.1Live
GET /v1/attendancev1.1Live
GET /v1/leave-requestsv1.3Live
GET /v1/departmentsv1.4Live
GET /v1/leave-balancesv1.4Live
GET /v1/payslipsv1.4Live
GET /v1/compliance-deadlinesv1.4Live
GET /v1/webhooksv1.2Live
POST /v1/webhooksv1.2Live
GET /v1/webhooks/{webhook_id}v1.2Live
PATCH /v1/webhooks/{webhook_id}v1.2Live
DELETE /v1/webhooks/{webhook_id}v1.2Live
POST /v1/webhooks/{webhook_id}/testv1.2Live
GET /v1/webhooks/{webhook_id}/deliveriesv1.2Live
POST /v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverv1.2Live

Follow the changelog for what ships next. To try every endpoint quickly, import the Postman collection and set its apiKey variable to your ah_test_ key.