Get Employee by id

GET 
/business-structure/employees/:employee_id

Returns a single employee by identifier.

Request

Path Parameters

employee_id uuidrequired

Employee identifier

Responses

200

OK

application/json

Schema

Schema

id uuidrequired

Employee identifier

name stringrequired

Possible values: >= 5 characters and <= 64 characters

Employee display name

phone stringrequired

Employee phone number

email stringrequired

Employee email address

role PublicEmployeeRoleDTO (string)required

Possible values: [admin, owner, manager, cashier, courier, guest, unknown]

Employee role

external_data

object

nullable

External system reference data linked to this entity.

id stringrequired

Possible values: >= 4 characters and <= 128 characters

Unique identifier in the external system

property name* any

External system reference data linked to this entity.

created_at date-timerequired

Date and time when the employee record was created

updated_at date-timerequired

Date and time when the employee record was last updated

Example (from schema)

{
  "id": "eeeeeeee-eeee-4eee-8eee-eeeeeeeeeeee",
  "name": "John Smith",
  "phone": "+971001234567",
  "email": "john.smith@example.com",
  "role": "admin",
  "external_data": {
    "id": "external-system-id-001"
  },
  "created_at": "2026-07-28T10:03:43.346Z",
  "updated_at": "2026-07-28T10:03:43.346Z"
}

400

Bad request — malformed syntax, invalid parameters, or failed validation. Typical code values: validation_error, invalid_request. List endpoints that accept a cursor parameter additionally return invalid_cursor when the cursor is invalid or expired.

application/problem+json

Schema

Schema

title stringrequired

Short human-readable summary

type stringrequired

URI reference identifying the problem category

instance stringnullable

URI reference identifying the specific request that caused this error (e.g. the request path).

trace_id stringrequired

Correlation id for support (report when contacting support)

status int32required

HTTP status code

code stringrequired

Machine-readable code for client branching

detail stringnullable

Human-readable explanation (optional)

reason string

Stable extension when code is existing_entity_conflict. For a duplicate external_data.id within the company, the value is duplicate_external_data_id.

errors

object

nullable

Present when code is validation_error. Keys are field names; values are arrays of human-readable error messages for that field.

property name*

string[]

nullable

Array [

string

]

Example (from schema)

{
  "title": "string",
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "instance": "/api/catalog/goods/regular",
  "trace_id": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00",
  "status": 0,
  "code": "validation_error",
  "detail": "string",
  "reason": "duplicate_external_data_id",
  "errors": {
    "uom_id": [
      "'uom_id' must not be empty."
    ],
    "vat": [
      "'vat' must not be empty."
    ],
    "variations": [
      "'variations' must contain between 1 and 150 items."
    ]
  }
}

validation

{
  "title": "One or more errors occurred.",
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "trace_id": "00-00000000000000000000000000000000-00000000-00",
  "status": 400,
  "instance": "/api/catalog/goods/regular",
  "code": "validation_error",
  "errors": {
    "name": [
      "'name' must not be empty."
    ]
  }
}

401

Missing or invalid credentials before the gateway forwards context (when applicable). The response has no body (empty payload).

403

Caller is not allowed to access this resource or company. The response has no body (empty payload).

404

Resource not found or not visible for the resolved company. The response has no body (empty payload).

429

Rate limit exceeded.

Response Headers

• Retry-After

  integer

  Seconds to wait before retrying

application/problem+json

Schema

Schema

title stringrequired

Short human-readable summary

type stringrequired

URI reference identifying the problem category

instance stringnullable

URI reference identifying the specific request that caused this error (e.g. the request path).

trace_id stringrequired

Correlation id for support (report when contacting support)

status int32required

HTTP status code

code stringrequired

Machine-readable code for client branching

detail stringnullable

Human-readable explanation (optional)

reason string

Stable extension when code is existing_entity_conflict. For a duplicate external_data.id within the company, the value is duplicate_external_data_id.

errors

object

nullable

Present when code is validation_error. Keys are field names; values are arrays of human-readable error messages for that field.

property name*

string[]

nullable

Array [

string

]

Example (from schema)

{
  "title": "string",
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "instance": "/api/catalog/goods/regular",
  "trace_id": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00",
  "status": 0,
  "code": "validation_error",
  "detail": "string",
  "reason": "duplicate_external_data_id",
  "errors": {
    "uom_id": [
      "'uom_id' must not be empty."
    ],
    "vat": [
      "'vat' must not be empty."
    ],
    "variations": [
      "'variations' must contain between 1 and 150 items."
    ]
  }
}

rateLimit

{
  "title": "Too Many Requests",
  "type": "https://tools.ietf.org/html/rfc6585#section-4",
  "trace_id": "00-00000000000000000000000000000000-00000000-00",
  "status": 429,
  "code": "unexpected_error"
}

500

Unexpected server error.

application/problem+json

Schema

Schema

title stringrequired

Short human-readable summary

type stringrequired

URI reference identifying the problem category

instance stringnullable

URI reference identifying the specific request that caused this error (e.g. the request path).

trace_id stringrequired

Correlation id for support (report when contacting support)

status int32required

HTTP status code

code stringrequired

Machine-readable code for client branching

detail stringnullable

Human-readable explanation (optional)

reason string

Stable extension when code is existing_entity_conflict. For a duplicate external_data.id within the company, the value is duplicate_external_data_id.

errors

object

nullable

Present when code is validation_error. Keys are field names; values are arrays of human-readable error messages for that field.

property name*

string[]

nullable

Array [

string

]

Example (from schema)

{
  "title": "string",
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "instance": "/api/catalog/goods/regular",
  "trace_id": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00",
  "status": 0,
  "code": "validation_error",
  "detail": "string",
  "reason": "duplicate_external_data_id",
  "errors": {
    "uom_id": [
      "'uom_id' must not be empty."
    ],
    "vat": [
      "'vat' must not be empty."
    ],
    "variations": [
      "'variations' must contain between 1 and 150 items."
    ]
  }
}

unexpected

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.6.1",
  "trace_id": "00-00000000000000000000000000000000-00000000-00",
  "status": 500,
  "code": "internal_server_error"
}

503

Service temporarily unavailable.

application/problem+json

Schema

Schema

title stringrequired

Short human-readable summary

type stringrequired

URI reference identifying the problem category

instance stringnullable

URI reference identifying the specific request that caused this error (e.g. the request path).

trace_id stringrequired

Correlation id for support (report when contacting support)

status int32required

HTTP status code

code stringrequired

Machine-readable code for client branching

detail stringnullable

Human-readable explanation (optional)

reason string

Stable extension when code is existing_entity_conflict. For a duplicate external_data.id within the company, the value is duplicate_external_data_id.

errors

object

nullable

Present when code is validation_error. Keys are field names; values are arrays of human-readable error messages for that field.

property name*

string[]

nullable

Array [

string

]

Example (from schema)

{
  "title": "string",
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "instance": "/api/catalog/goods/regular",
  "trace_id": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00",
  "status": 0,
  "code": "validation_error",
  "detail": "string",
  "reason": "duplicate_external_data_id",
  "errors": {
    "uom_id": [
      "'uom_id' must not be empty."
    ],
    "vat": [
      "'vat' must not be empty."
    ],
    "variations": [
      "'variations' must contain between 1 and 150 items."
    ]
  }
}

unavailable

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.6.4",
  "trace_id": "00-00000000000000000000000000000000-00000000-00",
  "status": 503
}

Loading...