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

# List dedicated messages

> Requires `messages:read` on an organization service key. Project/environment/sender restrictions apply. See the matching guide for prerequisites and limits.

Requires `messages:read`. See [authentication](https://docs.sendlyy.app/guides/authentication.md) and the matching product guide before live use.


## OpenAPI

````yaml GET /api/v1/messages
openapi: 3.1.0
info:
  title: Sendlyy Developer API
  version: v1
  description: >-
    WhatsApp messaging, shared Verify/Notify, contacts and delivery
    infrastructure. AI agents are a dashboard offering and are excluded. Live
    provider services require approval and enablement; see availability.
servers:
  - url: https://api.sendlyy.app
    description: >-
      Live API host; availability depends on deployed version and enabled
      services.
security:
  - bearerAuth: []
paths:
  /api/v1/messages:
    get:
      tags:
        - Messaging
      summary: List dedicated messages
      description: >-
        Requires `messages:read` on an organization service key.
        Project/environment/sender restrictions apply. See the matching guide
        for prerequisites and limits.
      operationId: get-messages
      parameters:
        - name: projectId
          in: query
          schema:
            type: string
            format: uuid
        - name: environmentId
          in: query
          schema:
            type: string
            format: uuid
        - name: Page
          in: query
          schema:
            pattern: ^-?(?:0|[1-9]\d*)$
            type:
              - integer
              - string
            format: int32
        - name: PageSize
          in: query
          schema:
            pattern: ^-?(?:0|[1-9]\d*)$
            type:
              - integer
              - string
            format: int32
      responses:
        '200':
          description: List dedicated messages
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Server-generated correlation identifier.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                            senderId:
                              type: string
                              format: uuid
                            environmentId:
                              type: string
                              format: uuid
                            status:
                              type: string
                            source:
                              type: string
                            failureCode:
                              type: string
                            amount:
                              type: number
                            createdAt:
                              type: string
                              format: date-time
                      page:
                        type: integer
                      pageSize:
                        type: integer
                      totalItems:
                        type: integer
                      totalPages:
                        type: integer
                      hasNextPage:
                        type: boolean
                      hasPreviousPage:
                        type: boolean
                    required:
                      - items
                      - page
                      - pageSize
                      - totalItems
                      - totalPages
                      - hasNextPage
                      - hasPreviousPage
                required:
                  - message
                  - data
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperError'
        '401':
          description: Invalid, expired or revoked credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperError'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperError'
        '404':
          description: Resource missing or outside allowed scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperError'
        '409':
          description: State, funds or idempotency conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperError'
        '422':
          description: Semantic validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperError'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperError'
        '500':
          description: Unexpected server failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperError'
        '502':
          description: Upstream provider failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperError'
        '503':
          description: Service or provider not enabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperError'
      security:
        - bearerAuth: []
components:
  schemas:
    DeveloperError:
      type: object
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sendlyy organization service key

````

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