Skip to main content

Get Employees page

GET 
/business-structure/employees

Returns a paginated list of employees for the company resolved from gateway context. Page size is fixed at 20 items per page.

Request​

Query Parameters

    cursor string

    Possible values: <= 128 characters

    Pagination cursor (opaque token). Invalid or expired cursors yield 400 with code invalid_cursor.

    search_text string

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

    Case-insensitive text match against employee name.

    phone string

    Possible values: >= 2 characters and <= 32 characters

    Filter by exact employee phone number.

    order_by string

    Possible values: [name_asc, name_desc, created_at_asc, created_at_desc]

    Default value: created_at_asc

    Sort order for returned employees.

Responses​

OK

Schema

    cursor stringnullable

    Token of the next page of the list. null when there is no next page.

    items

    object[]

    required

  • Array [

    • 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; null when the employee has no external system link

    id stringrequired

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

    Unique identifier in the external system

    property name* anynullable

    External system reference data; null when the employee has no external system link

    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

  • ]

Loading...