BEbetagouv
labels

GET /api/v1.0/labels/

    List all labels accessible to the user in a hierarchical structure.

    The response returns labels in a tree structure where:
    - Labels are ordered alphabetically by name
    - Each label includes its children (sub-labels)
    - The hierarchy is determined by the label's name (e.g., "Inbox/Important" is a child of "Inbox")

    You can filter labels by mailbox using the mailbox_id query parameter.

Request

  • The document declares no server URL.
  • Auth
    API key in cookie sessionid

Query parameters

mailbox_idstring uuid
            Filter labels by mailbox ID. If not provided, returns labels from all accessible mailboxes.

Response

List of labels in hierarchical structure

idstring uuid required
namestring required
slugstring required
colorstring required
display_namestring required
childrenTreeLabel[] required circular
descriptionstring required
is_autoboolean required

Changes

No recorded changes to this operation across all 60 revisions of this API.