labels

Discover labels

Lists the label names in use on the inbox's received and sent mail, with how many messages carry each in received_count and sent_count. prefix narrows the list to names starting with it, case-sensitive.

A name disappears once no message carries it. There is no separate step to create, rename or delete a label: add or remove it on messages.

get/v1/inboxes/{inbox_id}/labels

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/inboxes/{inbox_id}/labels
  • Auth: HTTP bearer

Path parameters

inbox_idstring required

Cherami resource ID returned by the API.

Query parameters

limitinteger

Results per page.

cursorstring

next_cursor from the previous page. Keep the URL, filters and order unchanged.

prefixstring

Only names starting with this text, case-sensitive; empty means all. At most 128 UTF-8 bytes, supplied once.

Response

Success.

next_cursorstring nullable required

Changes

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