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

> Returns a paginated list of notes (50 per page). Filter by contact and/or search the note body.

List notes (paginated, 50/page); filter by contact, search, all_teams

**Response shape:** `data` is an object with `count`, `page`, `pages` and `results`. It does **not** return `per_page`, `has_more` or `has_less`.



## OpenAPI

````yaml /api-reference/specs/notes.json get /api/notes
openapi: 3.1.0
info:
  title: ConveYour API — Notes
  description: Create, list, update, and delete internal notes attached to a contact.
  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: Notes
    description: Create, list, update, and delete internal notes attached to a contact.
paths:
  /api/notes:
    get:
      tags:
        - Notes
      summary: List notes
      description: >-
        Returns a paginated list of notes (50 per page). Filter by contact
        and/or search the note body.


        List notes (paginated, 50/page); filter by contact, search, all_teams


        **Response shape:** `data` is an object with `count`, `page`, `pages`
        and `results`. It does **not** return `per_page`, `has_more` or
        `has_less`.
      operationId: listNotesPaginated50PageFilterByContactSearchAllTeams
      parameters:
        - name: contact
          in: query
          description: >-
            Filter to notes attached to this contact ID. When set, pinned notes
            are returned first.
          schema:
            type: string
        - name: search
          in: query
          description: Filter to notes whose body contains this text (substring match).
          schema:
            type: string
        - $ref: '#/components/parameters/teams'
        - name: all_teams
          in: query
          description: >-
            Include notes from every team the caller can see, not just the
            scoped team.
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          results:
                            type: array
                            items:
                              $ref: '#/components/schemas/Note'
                          page:
                            type: integer
                            description: Current page number.
                          pages:
                            type: integer
                            description: Total number of pages.
                          count:
                            type: integer
                            description: Total matching records across all pages.
              example:
                status: ok
                message: 2 notes found
                data:
                  results:
                    - id: 1024
                      org_id: 990
                      user_id: 42
                      contact_id: 64a1b2c3d4e5f6a7b8c9d0e1
                      body: Left a voicemail, following up @Jane_Doe
                      pinned: true
                      all_teams: false
                      created_at: '2026-07-29 14:03:11'
                      updated_at: '2026-07-29 14:03:11'
                      contact_name: John Smith
                      user_name: Alex Rivera
                  page: 1
                  pages: 1
                  count: 2
        '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.
    Note:
      type: object
      description: >-
        A contact note. Returns the stored columns plus `contact_name` and
        `user_name`; `pinned` is always a boolean.
      properties:
        id:
          type: integer
          description: Note ID (integer, not an ObjectId).
        contact_id:
          type: string
          description: Contact the note belongs to.
        body:
          type: string
          description: Note text.
        org_id:
          type: integer
          description: Owning organization.
        user_id:
          type: integer
          description: Author.
        pinned:
          type: boolean
          description: Always a boolean.
        all_teams:
          type: boolean
          description: Whether the note is visible to every team.
        contact_name:
          type: string
          description: Computed per request; empty string when the contact is missing.
        user_name:
          type: string
          description: Computed per request; empty string when the user is missing.
        created_at:
          type: string
          description: MySQL datetime.
        updated_at:
          type: string
          description: MySQL datetime.
      required:
        - contact_id
        - body
  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.