> ## Documentation Index
> Fetch the complete documentation index at: https://docs.connie.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List labels

> With no filter, returns the workspace's labels. With `conversationId`, returns the labels on that conversation. With `conversationIds`, returns `labelsByConversation`. With `filterByLabel`, returns the IDs of conversations carrying that label.




## OpenAPI

````yaml /openapi/inbox.yaml get /inbox/labels
openapi: 3.1.0
info:
  title: Connie Inbox API
  version: 1.0.0
  description: >
    Endpoints the Connie web app uses for the Inbox: conversations, messages,
    drafts, labels, views, and the Calls and Meetings views. They authenticate
    with your signed-in browser session — see
    https://docs.connie.ai/api-reference/authentication. These are the app's own
    endpoints and can change when the app changes.
servers:
  - url: https://connie.ai/api
security:
  - sessionCookie: []
tags:
  - name: Conversations
    description: List, count, pin, star, assign and bulk-update conversations.
  - name: Messages
    description: Read messages, read state, reactions, stars, bookmarks and pins.
  - name: Sending
    description: >-
      Send new emails and chats, reply, search recipients and upload
      attachments.
  - name: Drafts
    description: Drafts saved in Connie and drafts stored in a connected mailbox.
  - name: Labels
    description: Workspace labels and the labels on each conversation.
  - name: Views
    description: Custom Inbox views.
  - name: Spam
    description: Mark conversations as spam or not spam.
  - name: Meetings and calls
    description: >-
      Recorded meetings and dialer calls shown in the Inbox, and their action
      items.
paths:
  /inbox/labels:
    get:
      tags:
        - Labels
      summary: List labels
      description: >
        With no filter, returns the workspace's labels. With `conversationId`,
        returns the labels on that conversation. With `conversationIds`, returns
        `labelsByConversation`. With `filterByLabel`, returns the IDs of
        conversations carrying that label.
      operationId: listLabels
      parameters:
        - $ref: '#/components/parameters/WorkspaceId'
        - name: conversationId
          in: query
          description: One conversation's `id`. `messageId` is accepted as an alias.
          schema:
            type: string
        - name: conversationIds
          in: query
          description: Comma-separated conversation IDs.
          schema:
            type: string
        - name: filterByLabel
          in: query
          description: A label name.
          schema:
            type: string
      responses:
        '200':
          description: Labels. The shape depends on the filter used.
          content:
            application/json:
              schema:
                type: object
                properties:
                  labels:
                    type: array
                    items:
                      $ref: '#/components/schemas/Label'
                  labelsByConversation:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: object
                        additionalProperties: true
                  conversationIds:
                    type: array
                    items:
                      type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    WorkspaceId:
      name: workspaceId
      in: query
      required: true
      description: >
        Your workspace ID. Also accepted as `workspace_id`, the `x-workspace-id`
        header, or `workspaceId` in a JSON body. If you leave it out, the
        request silently runs against the first workspace you joined.
      schema:
        type: string
        format: uuid
  schemas:
    Label:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        color:
          type: string
        description:
          type:
            - string
            - 'null'
          description: AI criteria used when `ai_auto_apply` is on.
        ai_auto_apply:
          type: boolean
        label:
          type: string
          description: Label name, on labels applied to a conversation.
        conversation_id:
          type: string
        label_id:
          type: string
        applied_by:
          type: string
          description: '`user` or `ai`.'
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
  responses:
    Unauthorized:
      description: No valid session, or the session expired (`SESSION_EXPIRED`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Too many requests. Wait for the number of seconds in `Retry-After`.
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    sessionCookie:
      type: apiKey
      in: header
      name: Cookie
      description: >-
        The full Cookie header copied from a signed-in connie.ai browser
        request. See the Authentication page.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.