Labels

Retrieve a label

Requires scope: read.

get/v1/labels/{id}

Request

  • Base URL: https://api.mails.ai
  • URL: https://api.mails.ai/v1/labels/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Label id (lbl_…).

Response

The label.

idstring required

Label id (lbl_…).

namestring required

Unique in the workspace, ignoring case.

color'gray' | 'red' | 'orange' | 'amber' | 'yellow' | 'green' | 'teal' | 'cyan' | 'blue' | 'indigo' | 'purple' | 'pink' required

The label's colour, one of 12 palette names: gray unless another was chosen.

created_atstring date-time required

When the label was created (UTC).

updated_atstring date-time required

When the label was last changed with PATCH, even by a request that left it as it was. Equal to created_at on a label never patched.

Changes

No recorded changes to this operation across all 1 revision of this API.