List People with Asset Filtering

import { TrebellarApiClient } from "@trebellar/api-sdk";
async function main() {
    const client = new TrebellarApiClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.people.listPeople({});
}
main();

{
  "data": [
    {
      "id": "string",
      "groups": [
        {
          "id": "string",
          "name": "string",
          "status": "PEOPLE_GROUP_STATUS_UNKNOWN",
          "path": "string",
          "parentId": "string",
          "avatarUrl": "string",
          "description": "string",
          "properties": {
            "color": "#FF5722"
          },
          "externalId": "string"
        }
      ],
      "externalId": "string",
      "assetId": "st_sf_tower_01",
      "name": "string",
      "hireDate": 1.1,
      "employmentStatus": "active",
      "terminationDate": 1.1,
      "address": {
        "raw": "123 Main St, Apt 4B, San Francisco, CA 94105",
        "postalCode": "94105",
        "streetName": "Main St",
        "city": "San Francisco",
        "state": "CA",
        "countryIso": "US"
      },
      "properties": {},
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

import { TrebellarApiClient } from "@trebellar/api-sdk";
async function main() {
    const client = new TrebellarApiClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.people.listPeople({});
}
main();

{
  "data": [
    {
      "id": "string",
      "groups": [
        {
          "id": "string",
          "name": "string",
          "status": "PEOPLE_GROUP_STATUS_UNKNOWN",
          "path": "string",
          "parentId": "string",
          "avatarUrl": "string",
          "description": "string",
          "properties": {
            "color": "#FF5722"
          },
          "externalId": "string"
        }
      ],
      "externalId": "string",
      "assetId": "st_sf_tower_01",
      "name": "string",
      "hireDate": 1.1,
      "employmentStatus": "active",
      "terminationDate": 1.1,
      "address": {
        "raw": "123 Main St, Apt 4B, San Francisco, CA 94105",
        "postalCode": "94105",
        "streetName": "Main St",
        "city": "San Francisco",
        "state": "CA",
        "countryIso": "US"
      },
      "properties": {},
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

Retrieve a list of people with optional filtering by asset assignments. Use the forAssetIds parameter to filter people who are assigned to specific assets (desks, spaces, etc.). Returns complete employee profiles including contact information, employment status, group memberships, and current asset assignments.

Authentication

X-Trebellar-Api-Keystring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

forAssetIdsstringOptional

Response

People list retrieved successfully with complete profiles and asset assignments

datalist of objects

Errors

404

Not Found Error

1	import { TrebellarApiClient } from "@trebellar/api-sdk";
2
3	async function main() {
4	const client = new TrebellarApiClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.people.listPeople({});
8	}
9	main();

1	{
2	"data": [
3	{
4	"id": "string",
5	"groups": [
6	{
7	"id": "string",
8	"name": "string",
9	"status": "PEOPLE_GROUP_STATUS_UNKNOWN",
10	"path": "string",
11	"parentId": "string",
12	"avatarUrl": "string",
13	"description": "string",
14	"properties": {
15	"color": "#FF5722"
16	},
17	"externalId": "string"
18	}
19	],
20	"externalId": "string",
21	"assetId": "st_sf_tower_01",
22	"name": "string",
23	"hireDate": 1.1,
24	"employmentStatus": "active",
25	"terminationDate": 1.1,
26	"address": {
27	"raw": "123 Main St, Apt 4B, San Francisco, CA 94105",
28	"postalCode": "94105",
29	"streetName": "Main St",
30	"city": "San Francisco",
31	"state": "CA",
32	"countryIso": "US"
33	},
34	"properties": {},
35	"createdAt": "string",
36	"updatedAt": "string"
37	}
38	]
39	}