List people
Lists the staff of your account with their departments and weekly shifts.
GET https://cotlet.dev/api/v1/breezeway/peoples
read
Returns each person with ID, name, role, departments, groups and shifts per weekday. The person ID is what assign_task and create_task take. Reading people needs an administrator or supervisor account.
Parameters
| Name | Type | Description |
|---|---|---|
| status string | string | One of active, invited, inactive. Defaults to active. |
Request
curl https://cotlet.dev/api/v1/breezeway/peoples \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("breezeway", "list_people")const result = await cotlet.call('breezeway', 'list_people');cotlet call breezeway list_peopleExample response
{
"people": [
{
"person_id": 136,
"name": "Ana Lopez",
"role": "service_partner",
"departments": [
"housekeeping",
"inspection"
],
"shifts": {
"monday": [
{
"start": "09:00",
"end": "17:00"
}
]
}
},
{
"person_id": 187,
"name": "Marco Diaz",
"role": "service_partner",
"departments": [
"maintenance"
],
"shifts": {
"monday": [
{
"start": "08:00",
"end": "16:00"
}
]
}
}
]
}