Staff

Working with staff in Menuflow

Staff are the personnel who work at a location and serve guests. The main purpose of the Staff API calls is to log which staff member is serving which tables and subsequent orders. This allows the Menuflow platform to track tips and make sure they are allocated to the correct staff member.

---

Get Staff

Call to retrieve a list of staff members serving at a specific location.

List Request

GET https://api.menuflow.dev/go/staff/{location_id}

curl --location 'https://api.menuflow.dev/go/staff/{location_id}' --header 'x-api-key: YOUR-API-KEY'

Path Parameters

Name	Type	Description
location_id*	integer	location_id of were the staff member works

200: OK staff members found

{
    "status": 200,
    "location_id": 1220,
    "records": 4,
    "result": [
        {
            "id": 4001,
            "first_name": "Pooja",
            "last_name": "Kshetri",
            "joined": "2023-10-12 12:36:13",
            "isDeleted": 0
        },
        {
            "id": 4002,
            "first_name": "Rajat",
            "last_name": "Sharma",
            "joined": "2023-10-12 12:36:31",
            "isDeleted": 0
        },
        {
            "id": 4003,
            "first_name": "Mehak",
            "last_name": "Phutela",
            "joined": "2023-10-12 12:37:24",
            "isDeleted": 0
        },
        {
            "id": 4004,
            "first_name": "Elon",
            "last_name": "Musk",
            "joined": "2023-10-12 12:38:06",
            "isDeleted": 0
        }
    ]
}

404: Not Found no staff found

{
    "status_code": "404",
    "message": "no staff members were found"
}

Add Staff

Call to add a new member of staff to a specific location.

Add Request

POST https://api.menuflow.dev/go/staff/{location_id}

curl

--location 'https://api.menuflow.dev/go/staff/{location_id}' --header 'Content-Type: text/plain' --header 'x-api-key: YOUR-API-KEY' --data '{

"first_name": "Jack",

"last_name": "Dorsey"

}'

Path Parameters

Name	Type	Description
location_id*	integer	location_id of new staff member

201: Created added successful

{
    "status": 201,
    "staff_id": 219082109
}

403: Forbidden request failed

Delete Staff

Call to delete a specific staff member. Deleted staff members may still be shown in tipping reports.

Delete Request

DELETE https://api.menuflow.dev/go/staff/{staff_id}

curl

--location --request DELETE 'https://api.menuflow.dev/go/staff/{staff_id}' --header 'x-api-key: YOUR-API-KEY'

Path Parameters

Name	Type	Description
staff_id*	integer	staff_id of the member to delete

200: OK deletion successful

{ 
    "status": 200, 
    "staff_id": 39083209, 
    "deleted": 1 
}

404: Not Found deletion failed

{
    "status_code": "404",
    "message": "staff member not found, deletion failed"
}