People and roles

The person object

{
  "id": "0195f0a1-7c2e-7b3a-9d41-6f0a2c8e1b12",
  "name": "Dana Driver",
  "email": "[email protected]",
  "status": "active",
  "roles": ["Driver"],
  "location_ids": ["0195f0a1-7c2e-7b3a-9d41-6f0a2c8e1b04"]
}

status is invited until they accept, then active, or deactivated after they leave.

`GET /api/v1/people`

Needs people:read and permission to manage staff. Owners see everyone. Everyone else sees people at their own locations. Supports per_page (1 to 200) and page.

`GET /api/v1/people/{id}`

Needs people:read, and you must be allowed to manage that person.

`POST /api/v1/people`

Needs people:create and permission to manage staff at the locations you choose. Sends the invitation email.

Field	Description
`name`	Required.
`email`	Required, must not already be in use.
`location_ids`	Required. Locations you manage.
`role_ids`	Optional. Roles at or below your own level.

`PATCH /api/v1/people/{id}`

Needs people:update. Send name, email or role_ids. A company always keeps at least one active Owner.

`DELETE /api/v1/people/{id}`

Needs people:delete. Deactivates the person: their access ends and everything they did stays in the history. You cannot deactivate yourself.

Roles

`GET /api/v1/roles`

Needs roles:read. Returns each role's id and name, for use in role_ids.