List labels

client.labels.list(?): LabelListResponse { id, name }

GET/v1/labels

List the labels the user has created for organizing chats. Filter chats by label via GET /v1/chats/search with labelID.

ReturnsExpand Collapse

LabelListResponse = Array<Label { id, name } >

Labels the user has created, sorted by name.

id: string

Unique identifier of the label.

name: string

Display name of the label.

List labels

import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop({
  accessToken: process.env['BEEPER_ACCESS_TOKEN'], // This is the default and can be omitted
});

const labels = await client.labels.list();

console.log(labels);

[
  {
    "id": "id",
    "name": "name"
  }
]

Returns Examples

[
  {
    "id": "id",
    "name": "name"
  }
]