List people

GET

/api/people

const url = 'http://localhost:3000/api/people';
const options = {method: 'GET', headers: {cookie: 'session=<session>'}};

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://localhost:3000/api/people \
  --cookie session=<session>

Not paginated. Rows include siteName, linked profile, and open-assignment assetCount.

Authorizations

cookieAuth

Parameters

Query Parameters

search

string

Match across full name and email

status

string

Filter by status

site

string format: uuid

Filter by site id

department

string

Filter by department

Responses

200

Success

application/json

object

data

Array<object>

object

required

string format: uuid

fullName

required

string

email

string

nullable

phone

string

nullable

jobTitle

string

nullable

department

string

nullable

employeeId

string

nullable

siteId

string format: uuid

nullable

siteName

string

nullable

profileId

string format: uuid

nullable

status

required

string

default: active

startDate

string format: date

nullable

notes

string

nullable

profile

object

string format: uuid

email

string

role

string

isActive

boolean

assetCount

Open assignments (list endpoint)

integer

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "data": [
    {
      "status": "active"
    }
  ]
}

401

Not authenticated

application/json

object

error

required

string

Example

{
  "error": "Not found"
}