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

# List SMS Messages

> Get the history of text messages (SMS) sent and received on your
platform.

You can narrow the list down using the filters — for example by user,
by phone number, by direction (sent or received), or by status.


## OpenAPI

````yaml GET /v1/platform/phone-numbers/sms/messages
openapi: 3.1.0
info:
  title: Finogate Platform API v1
  version: 0.1.0
servers:
  - url: https://api-sandbox.finogates.com
    description: Sandbox
  - url: https://api.finogates.com
    description: Production
security: []
tags:
  - name: auth
  - name: users
  - name: payees
  - name: verification
  - name: bank accounts
  - name: card processing
  - name: digital-assets
  - name: international
  - name: onboarding
  - name: pending-applications
  - name: wallets
  - name: payments
  - name: catalog
  - name: webhooks
  - name: phone-numbers
  - name: sms
  - name: calls
  - name: listings
  - name: embed-tokens
paths:
  /v1/platform/phone-numbers/sms/messages:
    get:
      tags:
        - sms
      summary: List SMS Messages
      description: |-
        Get the history of text messages (SMS) sent and received on your
        platform.

        You can narrow the list down using the filters — for example by user,
        by phone number, by direction (sent or received), or by status.
      operationId: list_phone_sms_messages_v1_platform_phone_numbers_sms_messages_get
      parameters:
        - name: user_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Show only messages where this user either sent or received the
              message.
            title: User Id
          description: >-
            Show only messages where this user either sent or received the
            message.
        - name: from_user_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Show only messages sent by this user.
            title: From User Id
          description: Show only messages sent by this user.
        - name: to_user_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Show only messages received by this user.
            title: To User Id
          description: Show only messages received by this user.
        - name: from_number
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Show only messages sent from this phone number.
            title: From Number
          description: Show only messages sent from this phone number.
        - name: to_number
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Show only messages sent to this phone number.
            title: To Number
          description: Show only messages sent to this phone number.
        - name: number
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Show only messages that involve this phone number, whether it sent
              or received.
            title: Number
          description: >-
            Show only messages that involve this phone number, whether it sent
            or received.
        - name: direction
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Show only 'inbound' messages (received) or 'outbound' messages
              (sent).
            title: Direction
          description: >-
            Show only 'inbound' messages (received) or 'outbound' messages
            (sent).
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              Show only messages in this state: 1 = waiting to send, 2 = sent, 3
              = delivered, 4 = failed, 5 = received.
            title: Status
          description: >-
            Show only messages in this state: 1 = waiting to send, 2 = sent, 3 =
            delivered, 4 = failed, 5 = received.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            description: How many messages to return per page (1 to 200).
            default: 50
            title: Limit
          description: How many messages to return per page (1 to 200).
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: How many messages to skip before this page starts.
            default: 0
            title: Offset
          description: How many messages to skip before this page starts.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - _AuthenticatedBearer: []
components:
  schemas:
    ListResponse:
      properties:
        status_code:
          type: integer
          title: Status Code
          description: HTTP status code for the response.
        data:
          title: Data
          description: Payload or error details.
        query_generated_time:
          type: integer
          title: Query Generated Time
          description: >-
            UTC timestamp (milliseconds since epoch) when response was
            generated.
        row_count:
          type: integer
          minimum: 0
          title: Row Count
          description: Total rows matching the request filters (not just this page).
        limit:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Limit
          description: >-
            Page size used for this response. Null for cursor-paginated
            endpoints.
        current_page:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Current Page
          description: >-
            1-indexed page number for this response. Null for cursor-paginated
            endpoints.
        total_page_number:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Total Page Number
          description: >-
            Total number of pages given the current limit. Null for
            cursor-paginated endpoints.
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: Cursor for the next page, if available.
      type: object
      required:
        - status_code
        - data
        - query_generated_time
        - row_count
      title: ListResponse
      description: |-
        Standard response wrapper for list responses.

        Declare ``ListResponse[list[SomeModel]]`` to render the real ``data``
        array schema in OpenAPI/Swagger; a bare ``ListResponse`` leaves ``data``
        untyped.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    _AuthenticatedBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v1/platform/auth/token

````