Users Model

The User resource represents administrators, managers, customers, drivers, waiters, professionals, and agents in an Ordering project.

API routes begin with /{api_version}/{language}/{project}. The paths below omit that shared prefix for readability.

Get a user

curl --request GET \
  --url 'https://apiv4.ordering.co/v400/en/your-project/users/42' \
  --header 'Authorization: Bearer <access-token>'

Replace your-project, 42, and <access-token> with values for your project and user.

{
  "error": true,
  "result": [
    "User does not exist"
  ]
}

{
  "error": true,
  "result": [
    "You do not have permission."
  ]
}

Core operations

Action	Method	Resource	Description
List users	`GET`	`/users`	Returns the users visible to the authenticated caller.
Get a user	`GET`	`/users/USER_ID`	Returns one user by numeric ID.
Create or register a user	`POST`	`/users`	Creates a user. Required inputs vary with the caller and project configuration.
Update a user	`POST`	`/users/USER_ID`	Partially updates one user. This API uses `POST`, not `PUT` or `PATCH`.
Delete a user	`DELETE`	`/users/USER_ID`	Deletes one user.

The get-user response uses the standard envelope:

{
  "error": false,
  "result": {
    "id": 42,
    "name": "Alex",
    "lastname": "Morgan",
    "email": "[email protected]",
    "country_phone_code": "1",
    "cellphone": "5550100100",
    "level": 3,
    "enabled": true,
    "created_at": "2026-07-28T15:30:00Z",
    "updated_at": "2026-07-28T15:30:00Z"
  }
}

List responses also include pagination metadata.

Resource fields

The public base schema documents a conservative response projection. Nullable fields may be null. Sparse responses may omit properties that were not requested.

Group	Properties
Identity	`id`, `name`, `middle_name`, `lastname`, `second_lastname`, `email`, `photo`, `birthdate`
Contact and address	`cellphone`, `country_phone_code`, `address`, `address_notes`, `zipcode`, `location`
Role and status	`level`, `busy`, `available`, `enabled`, `email_verified`, `phone_verified`
Timestamps	`created_at`, `updated_at`

The runtime object can contain additional role-specific, relation, and project-extension fields. Those fields are documented in operation-specific projections after publication review instead of being included in the public base contract.

Field notes

id is the user identifier.
birthdate uses a date with a four-digit year first.
country_phone_code is returned as a string without plus signs or spaces.
location is an object whose available properties depend on the operation.
created_at and updated_at use date-time strings.

User levels

Level	Meaning
0	Administrator
1	Legacy role; confirm its project-specific meaning before use
2	Business manager
3	Customer
4	Driver
5	Driver manager
6	Waiter
7	Waiter manager
8	Professional
9	Call-center agent

Role creation and visibility depend on the authenticated caller.

Sparse fields

Use the params query parameter to request a sparse projection. When a valid sparse projection is used, id remains present.

Limits

Visible fields and relations depend on the caller's role and project configuration.
Passwords and authentication tokens are never returned as part of the User resource.
Additional role-specific and relation fields are operation-specific and are not guaranteed by this base model.