EZ Texting Conversations API

The Conversations API from EZ Texting — 6 operation(s) for conversations.

GitHub OpenAPI

Operations 6

GET /v1/conversations List Conversations #
GET /v1/conversations/conversation/{userNumber}/{contactNumber} List Conversation Messages #
POST /v1/conversations/conversation/{userNumber}/{contactNumber}/archive Archive Conversation #
POST /v1/conversations/conversation/{userNumber}/{contactNumber}/restore Restore Conversation #
POST /v1/conversations/messages/read Read Conversation Messages #
POST /v1/conversations/messages/unread Unread Conversation Messages #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/eztexting-com:eztexting-com-conversations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

eztexting-com-conversations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: EzTexting Conversations API
  description: EzTexting API
  termsOfService: https://www.eztexting.com/terms
  contact:
    email: support@eztexting.com
  version: '1.0'
servers:
- url: a.eztexting.com
security:
- basic_auth:
  - read
  - write
- oauth_auth:
  - read
  - write
tags:
- name: Conversations
paths:
  /v1/conversations:
    get:
      tags:
      - Conversations
      summary: List Conversations
      description: List conversations matching provided filters
      operationId: list_3
      parameters:
      - name: page
        in: query
        description: Offset of a given page. The default is 0. See [pagination](https://eztexting.readme.io/docs/pagination) docs for more information.
        required: false
        schema:
          type: integer
          default: 0
        example: 0
      - name: size
        in: query
        description: The maximum number of records to return in a paged list response. The default is 20 and allowed values are 10, 20, 50, 100, 200
        required: false
        schema:
          type: string
          default: '20'
          enum:
          - '10'
          - '20'
          - '50'
          - '100'
          - '200'
        example: 20
      - name: sort
        in: query
        description: 'Sort field name and direction (asc or desc).  Example: sort=created,desc'
        required: false
        schema:
          type: string
      - name: filters[unread][eq]
        in: query
        description: 'Filter by unread flag: true, false'
        schema:
          type: string
      - name: filters[from][eq]
        in: query
        description: Filter by sending number
        schema:
          type: string
      - name: filters[archived][eq]
        in: query
        description: 'Filter by archived flag: true, false'
        schema:
          type: string
      - name: filters[optType][eq]
        in: query
        description: 'Filter by optType: OPTIN, OPTOUT, NONE'
        schema:
          type: string
      - name: filters[query][eq]
        in: query
        description: Filter by query matches contact name, contact number or last message text
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PageResponseConversation'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
  /v1/conversations/conversation/{userNumber}/{contactNumber}:
    get:
      tags:
      - Conversations
      summary: List Conversation Messages
      description: List messages in a particular conversation
      operationId: messageList
      parameters:
      - name: userNumber
        in: path
        description: User number
        required: true
        schema:
          type: string
      - name: contactNumber
        in: path
        description: Contact number
        required: true
        schema:
          type: string
      - name: read
        in: query
        description: Set to true to mark all unread messages returned as read
        required: false
        schema:
          type: boolean
          default: false
      - name: page
        in: query
        description: Zero-based page index (0..N)
        required: false
        schema:
          type: integer
          default: 0
          minimum: 0
      - name: size
        in: query
        description: The size of the page to be returned
        required: false
        schema:
          type: integer
          default: 20
          minimum: 1
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.'
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PageResponseMessage'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
  /v1/conversations/conversation/{userNumber}/{contactNumber}/archive:
    post:
      tags:
      - Conversations
      summary: Archive Conversation
      description: Archive a conversation
      operationId: archive
      parameters:
      - name: userNumber
        in: path
        description: User number
        required: true
        schema:
          type: string
      - name: contactNumber
        in: path
        description: Contact number
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
  /v1/conversations/conversation/{userNumber}/{contactNumber}/restore:
    post:
      tags:
      - Conversations
      summary: Restore Conversation
      description: Restore an archived conversation
      operationId: restore
      parameters:
      - name: userNumber
        in: path
        description: User number
        required: true
        schema:
          type: string
      - name: contactNumber
        in: path
        description: Contact number
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
  /v1/conversations/messages/read:
    post:
      tags:
      - Conversations
      summary: Read Conversation Messages
      description: Mark conversation message(s) as read
      operationId: messageRead
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdListString'
        required: true
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
  /v1/conversations/messages/unread:
    post:
      tags:
      - Conversations
      summary: Unread Conversation Messages
      description: Mark conversation message(s) as unread
      operationId: messageUnread
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdListString'
        required: true
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
components:
  schemas:
    LastMessage:
      type: object
      description: ConversationLastMessage
      properties:
        inbound:
          type: boolean
          description: Inbound message flag
        message:
          type: string
          description: Message text
        mediaUrl:
          type: string
          description: Media url
        sentAt:
          type: string
          format: date-time
          description: Message sent at timestamp
    PageResponseConversation:
      type: object
      description: Page
      properties:
        content:
          type: array
          description: The paged collection of elements
          items:
            $ref: '#/components/schemas/Conversation'
        number:
          type: integer
          format: int32
          description: The requested page number
          example: 0
        size:
          type: integer
          format: int32
          description: The requested page size
          example: 20
        totalElements:
          type: integer
          format: int64
          description: The total number of elements available
          example: 100
        totalPages:
          type: integer
          format: int32
          description: The total number of pages available
          example: 5
        numberOfElements:
          type: integer
          format: int32
          description: The number of elements in the current page
          example: 20
    Error:
      type: object
      properties:
        code:
          type: string
        title:
          type: string
        message:
          type: string
    PageResponseMessage:
      type: object
      description: Page
      properties:
        content:
          type: array
          description: The paged collection of elements
          items:
            $ref: '#/components/schemas/Message'
        number:
          type: integer
          format: int32
          description: The requested page number
          example: 0
        size:
          type: integer
          format: int32
          description: The requested page size
          example: 20
        totalElements:
          type: integer
          format: int64
          description: The total number of elements available
          example: 100
        totalPages:
          type: integer
          format: int32
          description: The total number of pages available
          example: 5
        numberOfElements:
          type: integer
          format: int32
          description: The number of elements in the current page
          example: 20
    IdListString:
      type: object
      properties:
        idList:
          type: array
          items:
            type: string
          minItems: 1
      required:
      - idList
    Conversation:
      type: object
      description: Conversation
      properties:
        userNumber:
          type: string
          description: User sending number
        contactNumber:
          type: string
          description: Contact phone number
        contactName:
          type: string
          description: Contact name
        lastMessage:
          $ref: '#/components/schemas/LastMessage'
          description: The last message in this conversation
        unreadCount:
          type: integer
          format: int32
          description: Number of unread messages in this conversation
        optIn:
          type: boolean
          description: Opt-in flag
        optOut:
          type: boolean
          description: Op-out flag
        archived:
          type: boolean
          description: Archived flag
    Message:
      type: object
      description: Message
      properties:
        id:
          type: string
          description: Message id
        userNumber:
          type: string
          description: User sending number
        contactNumber:
          type: string
          description: Contact phone number
        inbound:
          type: boolean
          description: Inbound message flag
        message:
          type: string
          description: Message text
        mediaUrl:
          type: string
          description: Media url
        sentAt:
          type: string
          format: date-time
          description: Sent at timestamp
        optIn:
          type: boolean
          description: Opt-in flag
        optOut:
          type: boolean
          description: Op-out flag
        status:
          type: string
          description: 'Message status: READ, UNREAD, DELETED'
          enum:
          - READ
          - UNREAD
          - PENDING
          - DELETED
        type:
          type: string
          description: 'Message type: SMS or MMS'
          enum:
          - SMS
          - MMS
        group:
          type: boolean
          description: Group message flag
        messageGroupId:
          type: string
          description: Message group id
    Errors:
      type: object
      properties:
        status:
          type: integer
          format: int32
        title:
          type: string
        detail:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basic_auth:
      type: http
      scheme: basic
    oauth_auth:
      type: oauth2
      flows:
        password:
          tokenUrl: http://nova-app.stg0.cf.wtf/oauth_token/generate/swagger
          scopes:
            read: ''
            write: ''
x-proxy-enabled: false
x-send-defaults: true
x-samples-languages:
- curl
- node
- ruby
- javascript
- python
- java
- swift
- kotlin
- go
- csharp
x-provenance:
  method: searched
  source: https://developers.eztexting.com/reference
  harvested: '2026-11-07'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.eztexting.com/reference/acquire-1.md
  - https://developers.eztexting.com/reference/acquire_1-1.md
  - https://developers.eztexting.com/reference/archive-1.md
  - https://developers.eztexting.com/reference/blockoutboundtexts-1.md
  - https://developers.eztexting.com/reference/check-1.md
  - https://developers.eztexting.com/reference/contactsadd-1.md
  - https://developers.eztexting.com/reference/contactsremove-1.md
  - https://developers.eztexting.com/reference/create-1.md
  - https://developers.eztexting.com/reference/create_1-1.md
  - https://developers.eztexting.com/reference/create_2-1.md
  - https://developers.eztexting.com/reference/create_3-1.md
  - https://developers.eztexting.com/reference/create_4-1.md
  - https://developers.eztexting.com/reference/create_5-1.md
  - https://developers.eztexting.com/reference/create_6-1.md
  - https://developers.eztexting.com/reference/createorupdate-1.md
  - https://developers.eztexting.com/reference/createorupdatebatch-1.md
  - https://developers.eztexting.com/reference/creditbalance-1.md
  - https://developers.eztexting.com/reference/delete-1.md
  - https://developers.eztexting.com/reference/delete_1-1.md
  - https://developers.eztexting.com/reference/delete_2-1.md
  - https://developers.eztexting.com/reference/delete_3-1.md
  - https://developers.eztexting.com/reference/delete_4-1.md
  - https://developers.eztexting.com/reference/delete_5-1.md
  - https://developers.eztexting.com/reference/delete_6-1.md
  - https://developers.eztexting.com/reference/details-1.md
  - https://developers.eztexting.com/reference/get-1.md
  - https://developers.eztexting.com/reference/get_1-1.md
  - https://developers.eztexting.com/reference/get_2-1.md
  - https://developers.eztexting.com/reference/get_3-1.md
  - https://developers.eztexting.com/reference/get_4-1.md
  - https://developers.eztexting.com/reference/get_5-1.md
  - https://developers.eztexting.com/reference/get_6-1.md
  - https://developers.eztexting.com/reference/list-1.md
  - https://developers.eztexting.com/reference/list_1-1.md
  - https://developers.eztexting.com/reference/list_2-1.md
  - https://developers.eztexting.com/reference/list_3-1.md
  - https://developers.eztexting.com/reference/list_4-1.md
  - https://developers.eztexting.com/reference/list_5-1.md
  - https://developers.eztexting.com/reference/list_6-1.md
  - https://developers.eztexting.com/reference/list_7-1.md
  - https://developers.eztexting.com/reference/list_8-1.md
  - https://developers.eztexting.com/reference/listcampaigns-1.md
  - https://developers.eztexting.com/reference/listresponsesdelivery-1.md
  - https://developers.eztexting.com/reference/listresponsesengagement-1.md
  - https://developers.eztexting.com/reference/listresponseslink-1.md
  - https://developers.eztexting.com/reference/messagelist-1.md
  - https://developers.eztexting.com/reference/messageread-1.md
  - https://developers.eztexting.com/reference/messageunread-1.md
  - https://developers.eztexting.com/reference/purchasecredits-1.md
  - https://developers.eztexting.com/reference/refresh-1.md
  - https://developers.eztexting.com/reference/release-1.md
  - https://developers.eztexting.com/reference/restore-1.md
  - https://developers.eztexting.com/reference/revoke-1.md
  - https://developers.eztexting.com/reference/update-1.md
  - https://developers.eztexting.com/reference/update_1-1.md
  - https://developers.eztexting.com/reference/update_2-1.md
  - https://developers.eztexting.com/reference/updatesettings-1.md
  merge:
    pages: 57
    deduped: 253
    conflicts_kept_first: 0