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

# List tags

> Returns all tags for the org.

List all tags

**Permission:** requires `tags`.

`messages_count` is only present when you pass `count=true`. Without it, tag records come back without that field — do not rely on it being there.

**Response shape:** `data` is a **flat array** of records. This endpoint ignores `page` — the full matching set comes back in one response.



## OpenAPI

````yaml /api-reference/specs/tags.json get /api/tags
openapi: 3.1.0
info:
  title: ConveYour API — Tags
  description: >-
    Create and manage conversation-message tags used to categorize and filter
    messages.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Tags
    description: >-
      Create and manage conversation-message tags used to categorize and filter
      messages.
paths:
  /api/tags:
    get:
      tags:
        - Tags
      summary: List tags
      description: >-
        Returns all tags for the org.


        List all tags


        **Permission:** requires `tags`.


        `messages_count` is only present when you pass `count=true`. Without it,
        tag records come back without that field — do not rely on it being
        there.


        **Response shape:** `data` is a **flat array** of records. This endpoint
        ignores `page` — the full matching set comes back in one response.
      operationId: listAllTags
      parameters:
        - name: count
          in: query
          description: >-
            When truthy, adds a `messages_count` field to each tag with the
            number of messages carrying that tag.
          schema:
            type: boolean
        - name: deleted
          in: query
          description: When truthy, returns only soft-deleted tags instead of active ones.
          schema:
            type: boolean
        - $ref: '#/components/parameters/teams'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/TagWithCount'
                        description: >-
                          All tags. Pass deleted=1 to list soft-deleted tags
                          instead. messages_count appears on each record only
                          when count=true is passed.
              example:
                status: ok
                message: success
                data:
                  - id: 64a1b2c3d4e5f6a7b8c9d0e1
                    name: Follow Up
                    org_id: '1234'
                    created_at: 1688169600
                    updated_at: 1688169600
                    deleted_at: null
                    messages_count: 12
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    TagWithCount:
      allOf:
        - $ref: '#/components/schemas/Tag'
        - type: object
          description: >-
            The list endpoint adds messages_count to each record, but only when
            count=true is passed.
          properties:
            messages_count:
              type: integer
              description: >-
                Number of messages carrying this tag. Present only when
                `count=true` is passed.
    Tag:
      type: object
      description: >-
        A tag record. `name` is the only editable field; the rest are standard
        record attributes and timestamps.
      properties:
        id:
          type: string
          description: Tag ID.
        org_id:
          type: integer
          description: Owning organization.
        user_id:
          type: integer
          description: User who created the tag.
        name:
          type: string
          description: Tag name.
        created_at:
          type: integer
          description: Unix timestamp.
        updated_at:
          type: integer
          description: Unix timestamp.
        deleted_at:
          type:
            - string
            - 'null'
          description: >-
            Soft-delete timestamp. Populated on records returned when deleted=1
            is passed; null otherwise.
      required:
        - name
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

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