API documentation

Everything you need to integrate with the Gini v2 Third-Party API.

Store API

Operators

Create and manage staff sub-accounts (operators) for your store, matching the dashboard's Operators screen.

List operators

Your operators, newest first. Returns name, email, phone, role, is_active. The password is never returned. Paginated.

GET /api/v2.0/third-party/operators

Signed

Get one

A single record by its numeric id. 404 if it is not yours.

GET /api/v2.0/third-party/operators/{operator}

Signed

Create

POST /api/v2.0/third-party/operators

Signed

Body parameters

Field	Type	Required	Description
`name`	string	Required	2–155 chars, unique across all operators.
`email`	string	Required	Unique across all operators.
`phone`	string	Required	Iraqi number, unique across all operators (normalised).
`password`	string	Required	Required on create; must meet the password policy. Hashed on write, never returned.
`role`	string	Required	admin, manager or cashier.
`is_active`	boolean	Optional	Defaults to true.

Notes

Send the body as JSON (Content-Type: application/json) so the password and every other field are covered by the signature — a form-encoded body is signed as empty and can be replayed with the fields changed.
password is required on create and optional on update (to rotate it); it is never included in any response.
name, email and phone are unique across every operator on the platform.
POST /operators is idempotent — send an Idempotency-Key header.

Update

Partial — send only the fields you are changing. 404 if it is not yours.

PUT /api/v2.0/third-party/operators/{operator}

Signed

Delete

DELETE /api/v2.0/third-party/operators/{operator}

Signed