> ## 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 folders

> Returns all bookmark folders.

List bookmark folders

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

**Groups are called `bookmarks` in the API.** The UI calls these Groups, but the model and every route use `bookmarks`. The name describes what the record actually is: a saved contact filter query — `filters` is a required field, and the saved query is what defines the segment, whether dynamic or static. "Bookmark" was the original word for saving that query; the UI later settled on "Group" for the same thing. Endpoint paths stay `/api/bookmarks` — only the naming in these docs follows the UI.



## OpenAPI

````yaml /api-reference/specs/bookmarks-groups.json get /api/bookmarks/folders
openapi: 3.1.0
info:
  title: ConveYour API — Groups (Bookmarks)
  description: Create and manage contact groups (bookmarks) and bookmark folders.
  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: Groups (Bookmarks)
    description: Create and manage contact groups (bookmarks) and bookmark folders.
paths:
  /api/bookmarks/folders:
    get:
      tags:
        - Groups (Bookmarks)
      summary: List folders
      description: >-
        Returns all bookmark folders.


        List bookmark folders


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


        **Groups are called `bookmarks` in the API.** The UI calls these Groups,
        but the model and every route use `bookmarks`. The name describes what
        the record actually is: a saved contact filter query — `filters` is a
        required field, and the saved query is what defines the segment, whether
        dynamic or static. "Bookmark" was the original word for saving that
        query; the UI later settled on "Group" for the same thing. Endpoint
        paths stay `/api/bookmarks` — only the naming in these docs follows the
        UI.
      operationId: listBookmarkFolders
      parameters:
        - name: folder_id
          in: query
          description: >-
            Filter to sub-folders under a specific parent folder. Omit to return
            all folders.
          schema:
            type: string
        - name: schema
          in: query
          description: 'Schema detail level. Default: `full`.'
          schema:
            type: string
        - name: page
          in: query
          description: >-
            Page number for paginated results (1-based). Omit or pass `0` for no
            pagination.
          schema:
            type: integer
        - name: per_page
          in: query
          description: 'Items per page when `page` is set. Default: `50`.'
          schema:
            type: integer
        - name: deleted
          in: query
          description: 'Pass `1` to include soft-deleted folders. Default: `0`.'
          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/BookmarkFolder'
              example:
                status: ok
                message: success
                data:
                  - id: 64a1b2c3d4e5f6a7b8c9d0e1
                    name: Regional Groups
                    folder_id: null
        '403':
          $ref: '#/components/responses/ForbiddenToken'
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.
    BookmarkFolder:
      type: object
      description: A bookmark folder, returned by the shared folder endpoints.
      properties:
        id:
          type: string
        name:
          type: string
          description: Folder name.
        org_id:
          type: integer
        user_id:
          type: integer
        order:
          type: number
          description: Sort order.
        bookmarks:
          oneOf:
            - type: array
              items:
                type: object
              description: All children, capped at limits.folder_children (default 1000).
            - type: object
              description: Returned instead when page is passed.
              properties:
                page:
                  type: integer
                pages:
                  type: integer
                count:
                  type: integer
                results:
                  type: array
                  items:
                    type: object
          description: >-
            Child bookmarks. A flat array by default; passing page switches it
            to a paginated object. Omitted when the requested schema level
            excludes it.
        bookmarks_count:
          type: integer
        folders:
          oneOf:
            - type: array
              items:
                type: object
              description: All children, capped at limits.folder_children (default 1000).
            - type: object
              description: Returned instead when page is passed.
              properties:
                page:
                  type: integer
                pages:
                  type: integer
                count:
                  type: integer
                results:
                  type: array
                  items:
                    type: object
          description: >-
            Child folders. A flat array by default; passing page switches it to
            a paginated object. Omitted when the requested schema level excludes
            it.
        folders_count:
          type: integer
        editable:
          type: boolean
          description: Always `true`.
        deletable:
          type: boolean
          description: Always `true`.
        created_at:
          type: integer
        updated_at:
          type: integer
      required:
        - id
        - name
  responses:
    ForbiddenToken:
      description: >-
        The token is missing, expired, or not permitted for this HTTP method.
        **This endpoint enforces no named permission**, so a 403 here never
        carries a `permission` field.
      content:
        application/json:
          example:
            status: failed
            message: Token is either expired or does not have the correct permissions
            data: []
  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.