List people

GET

/people

const url = 'http://127.0.0.1:7700/api/people';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://127.0.0.1:7700/api/people \
  --header 'Authorization: Bearer <token>'

Preview. For an admin or the owner. Each person with the phones paired for them.

Authorizations

deviceToken
accessToken

Responses

200

The people.

application/json

Array

object

required

string

name

required

string

role

required

owner everything an admin may, plus the owner’s controls. admin people, the policy, pairing phones and the kill switch. approver answers what the policy sends to them, up to limitCents. requester starts tasks and sees their own requests. auditor reads everything and changes nothing.

string

Allowed values: owner admin approver requester auditor

title

string

limitCents

required

The most this person may approve, in US cents. null for no limit.

integer | null

approvesFor

required

The names in the policy this person approves for.

Array<string>

email

Their work address from a sign-in. Kept in the box’s state only

string

phones

Array<object>

object

string

name

string

pairedAt

string format: date-time

Example

[
  {
    "id": "rosa",
    "role": "owner"
  }
]

403

The owner’s route, called by someone who is not the box’s own screen or a device paired as the owner.

application/json

object

error

required

What went wrong

string

Example

{
  "error": "only this computer's own screen or the owner's paired device can do this"
}