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

> Returns all bookmarks for the org. Optionally filter to bookmarks assigned to a specific folder.

**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
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:
    get:
      tags:
        - Groups (Bookmarks)
      summary: List groups
      description: >-
        Returns all bookmarks for the org. Optionally filter to bookmarks
        assigned to a specific folder.


        **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: listAllBookmarks
      parameters:
        - name: folder_id
          in: query
          description: >-
            Filter to bookmarks assigned to a specific folder. Pass the string
            `"null"` (not a JSON null) to return unfoldered bookmarks.
          schema:
            type: string
        - $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/Bookmark'
              example:
                status: ok
                message: success
                data:
                  - id: 64a1b2c3d4e5f6a7b8c9d0e1
                    name: Active Reps - Southwest
                    filters:
                      region: southwest
                      status: active
        '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.
    Bookmark:
      type: object
      description: >-
        A bookmark (saved contact filter, shown as a Group in the UI). Returns
        the stored attributes and adds `editable`, computed for the requesting
        user.
      properties:
        id:
          type: string
          description: Bookmark ID.
        org_id:
          type: integer
          description: Owning organization.
        user_id:
          type: integer
          description: User who created it.
        name:
          type: string
          description: Bookmark name.
        filters:
          type: object
          description: >-
            The contact filter. Accepted as an object or a JSON string, which
            validateModel() decodes before validating.
        folder_id:
          type: string
          description: Containing folder.
        teams:
          type: array
          description: >-
            Teams the bookmark is scoped to. Removed from the response when the
            org does not have the teams feature enabled.
        editable:
          type: boolean
          description: Computed per request; false when no user is resolved.
        created_at:
          type: integer
          description: Unix timestamp.
        updated_at:
          type: integer
          description: Unix timestamp.
      required:
        - name
        - filters
  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.