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

# List lookup history

> Returns your past number lookups, newest first, with the total count for paging. Each entry is the result as it was returned, including whether it was cached.



## OpenAPI

````yaml openapi-sms.yaml GET /api/v1/Account/{auth_id}/Sms/Lookup/History/
openapi: 3.0.3
info:
  title: Vobiz Messaging API
  description: >
    Send and receive SMS, MMS and RCS messages, buy messaging numbers, register
    for

    US 10DLC and toll-free, run broadcasts, manage conversations, opt-outs and
    webhooks.


    **Base URL:** `https://api.vobiz.ai/api/v1/Account/{auth_id}/Sms`, where
    `{auth_id}` is your

    account Auth ID. Paths in descriptions, such as `POST /Message/`, are
    relative to it.

    Coverage (`/api/v1/sms/coverage`) and `/api/v1/sms/numbers/countries` are
    not account data

    and keep their `https://api.vobiz.ai/api/v1/sms` URLs.


    **Authentication:** every request needs the `X-Auth-ID` and `X-Auth-Token`
    headers. The

    `{auth_id}` in the path must be the account those credentials belong to,
    otherwise the

    request returns `403`. Field names in this API are camelCase.


    The earlier URLs under `https://api.vobiz.ai/api/v1/sms` (for example `POST
    /api/v1/sms/messages`)

    still work.
  version: '1.0'
  contact:
    email: support@vobiz.ai
    url: https://www.vobiz.ai
servers:
  - url: https://api.vobiz.ai
    description: Production
security:
  - AuthID: []
    AuthToken: []
tags:
  - name: Messages
    description: Send messages and inspect their delivery state.
  - name: Numbers
    description: >-
      Messaging-capable numbers on your account, inventory search, purchase and
      release.
  - name: Number lookup
    description: >-
      Check whether numbers exist and are reachable on the mobile network, and
      which network serves them.
  - name: Coverage
    description: Where you can send, per country.
  - name: Conversations
    description: Two-way threads between one of your numbers and a contact.
  - name: Opt-outs
    description: Numbers that must not receive messages on a channel.
  - name: Webhooks
    description: Subscriptions that deliver message and broadcast events to your server.
  - name: Broadcasts
    description: Bulk sends from an uploaded recipient list.
  - name: RCS Senders
    description: RCS sender (agent) identities and their message templates.
  - name: 10DLC Brands
    description: US 10DLC brand registration.
  - name: 10DLC Campaigns
    description: US 10DLC campaigns, toll-free verification and supporting documents.
paths:
  /api/v1/Account/{auth_id}/Sms/Lookup/History/:
    parameters:
      - $ref: '#/components/parameters/AuthId'
    get:
      tags:
        - Number lookup
      summary: List lookup history
      description: >-
        Returns your past number lookups, newest first, with the total count for
        paging. Each entry is the result as it was returned, with `cached`
        showing whether it came from the cache. Inputs that could not be read as
        a phone number, and numbers that got no answer, are not recorded.
      operationId: list-lookup-history
      parameters:
        - name: limit
          in: query
          description: >-
            Maximum number of lookups to return. Defaults to `50`; `0` or a
            negative value also gives `50`, and a value above `200` returns
            `200`. A non-integer returns `400` with `limit must be an integer`.
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
        - name: offset
          in: query
          description: >-
            Number of lookups to skip before the page starts. Defaults to `0`. A
            negative value returns `400` with `offset must not be negative`, and
            a non-integer returns `400` with `offset must be an integer`.
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: A page of past lookups.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupHistory'
              example:
                lookups:
                  - input: +1 415 555 0123
                    number: '+14155550123'
                    valid: false
                    status:
                      group: REJECTED
                      name: REJECTED_ROUTE_NOT_AVAILABLE
                      description: Route not available
                    error: null
                    country:
                      iso: US
                      name: United States
                      dialCode: '1'
                    network: null
                    originalNetwork: null
                    ported: false
                    portedNetwork: null
                    roaming: false
                    roamingNetwork: null
                    cached: false
                    checkedAt: '2026-10-12T10:30:00Z'
                total: 1
        '400':
          description: '`limit` or `offset` is not an integer, or `offset` is negative.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                limit:
                  value:
                    error: limit must be an integer
                offset:
                  value:
                    error: offset must not be negative
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    AuthId:
      name: auth_id
      in: path
      required: true
      description: Your account Auth ID. It must match the `X-Auth-ID` header.
      schema:
        type: string
        example: MA_XXXXXXXX
  schemas:
    LookupHistory:
      type: object
      description: One page of your past lookups, newest first.
      properties:
        lookups:
          type: array
          description: >-
            The lookups on this page. `cached` tells whether each one was served
            from the cache.
          items:
            $ref: '#/components/schemas/LookupResult'
        total:
          type: integer
          description: Total number of recorded lookups on your account across all pages.
          example: 3
    Error:
      type: object
      description: >-
        The body of every error response: a flat object with one `error` string
        that explains what went wrong. Use the HTTP status code to decide how to
        handle the error, and log `error` for diagnosis.
      required:
        - error
      properties:
        error:
          type: string
          example: 'recipient has opted out: +14155550123'
          description: >-
            Human-readable explanation of the error, for example `phoneNumber is
            required` or `recipient has opted out: +14155550123`. Branch on the
            HTTP status code rather than on this text.
    LookupResult:
      type: object
      description: >-
        The result of checking one number. Inputs that could not be read as a
        phone number, or that got no answer, have `valid: false`, a `reason` and
        `null` for the network fields.
      properties:
        input:
          type: string
          description: The value you sent, trimmed.
          example: '+14155550123'
        number:
          type: string
          description: >-
            The number in E.164 format. An empty string when `input` could not
            be read as a phone number.
          example: '+14155550123'
        valid:
          type: boolean
          description: >-
            `true` when the number exists and is reachable: the status group is
            `DELIVERED`, or the network reported neither a status nor an error.
            `false` for a permanent error, any other status group, or an input
            that was not looked up.
        reason:
          type: string
          description: Why the number was not looked up. Present only for those inputs.
          enum:
            - missing phone number
            - contains letters or symbols
            - too short
            - too long
            - not a valid US/Canada number
            - not a valid Indian mobile number
            - no result for this number
        status:
          allOf:
            - $ref: '#/components/schemas/LookupStatus'
          nullable: true
          description: >-
            The network status. `null` when the network returned none or the
            number was not looked up.
        error:
          allOf:
            - $ref: '#/components/schemas/LookupFailure'
          nullable: true
          description: The network error. `null` when there was none.
        country:
          allOf:
            - $ref: '#/components/schemas/LookupCountry'
          nullable: true
          description: The number's country. `null` when it is unknown.
        network:
          allOf:
            - $ref: '#/components/schemas/LookupNetwork'
          nullable: true
          description: The network that serves the number now. `null` when it is unknown.
        originalNetwork:
          allOf:
            - $ref: '#/components/schemas/LookupNetworkName'
          nullable: true
          description: >-
            The network the number was originally issued by. `null` when it is
            unknown.
        ported:
          type: boolean
          description: '`true` when the number was moved to another network.'
        portedNetwork:
          allOf:
            - $ref: '#/components/schemas/LookupNetworkName'
          nullable: true
          description: >-
            The network the number was ported to. `null` unless `ported` is
            `true` and the network is known.
        roaming:
          type: boolean
          description: '`true` when the handset is roaming on another network.'
        roamingNetwork:
          allOf:
            - $ref: '#/components/schemas/LookupNetworkName'
          nullable: true
          description: >-
            The network the handset is roaming on. `null` unless `roaming` is
            `true` and the network is known.
        cached:
          type: boolean
          description: >-
            `true` when the result was reused from a lookup of the same number
            in the last 24 hours instead of asking the network again.
        checkedAt:
          type: string
          format: date-time
          description: >-
            When the network was asked, in RFC 3339 UTC. For a cached result,
            the time of the original lookup.
          example: '2026-10-12T10:30:00Z'
    GatewayError:
      type: object
      description: >-
        Error body returned by the Vobiz API gateway for authentication (`401`)
        and account-mismatch (`403`) failures, before the request reaches the
        messaging service. Unlike `Error`, `error` is an object.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: integer
              example: 401
              description: The HTTP status code, repeated.
            message:
              type: string
              example: Invalid authentication credentials
              description: Human-readable explanation of the failure.
    LookupStatus:
      type: object
      description: The network's answer for the number.
      properties:
        group:
          type: string
          description: >-
            Status group, upper-case, for example `DELIVERED` (the number is
            reachable), `UNDELIVERABLE`, `REJECTED`, `PENDING` or `EXPIRED`.
            `valid` is `true` only for `DELIVERED`.
          example: REJECTED
        name:
          type: string
          description: >-
            Detailed status name within the group, for example
            `REJECTED_ROUTE_NOT_AVAILABLE`.
          example: REJECTED_ROUTE_NOT_AVAILABLE
        description:
          type: string
          description: Human-readable explanation of the status.
          example: Route not available
    LookupFailure:
      type: object
      description: The network error for the number. `null` when there was none.
      properties:
        name:
          type: string
          description: Error name reported by the network.
        description:
          type: string
          description: Human-readable explanation of the error.
        permanent:
          type: boolean
          description: >-
            `true` when the error is permanent, for example a number that does
            not exist. A permanent error makes `valid` `false`.
    LookupCountry:
      type: object
      description: The country the number belongs to.
      properties:
        iso:
          type: string
          description: >-
            ISO 3166-1 alpha-2 country code. An empty string when the country
            could only be named, not matched to a code.
          example: US
        name:
          type: string
          description: Country name.
          example: United States
        dialCode:
          type: string
          description: Country calling code, without `+`.
          example: '1'
    LookupNetwork:
      type: object
      description: >-
        The network that serves the number now (the ported network when the
        number was ported).
      properties:
        name:
          type: string
          description: >-
            Network (carrier) name. An empty string when only the MCC/MNC is
            known.
          example: Example Mobile
        mccMnc:
          type: string
          description: >-
            Mobile country code and mobile network code of the serving network,
            for example `310260`.
          example: '310260'
    LookupNetworkName:
      type: object
      description: A network (carrier), by name.
      properties:
        name:
          type: string
          description: Network (carrier) name.
          example: Example Mobile
  responses:
    Unauthorized:
      description: >-
        Missing or invalid `X-Auth-ID` / `X-Auth-Token`. The API gateway answers
        before the request reaches the messaging service, so `error` is an
        object with `code` and `message`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GatewayError'
          examples:
            missing:
              summary: No credentials
              value:
                error:
                  code: 401
                  message: >-
                    Authentication required: provide either Authorization header
                    or X-Auth-ID and X-Auth-Token headers
            invalid:
              summary: Wrong Auth Token
              value:
                error:
                  code: 401
                  message: Invalid authentication credentials
    Forbidden:
      description: >-
        The `{auth_id}` in the path is not the account that the `X-Auth-ID` /
        `X-Auth-Token` credentials belong to. The API gateway answers, so
        `error` is an object with `code` and `message`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GatewayError'
          example:
            error:
              code: 403
              message: 'Access denied: account ID mismatch'
    ServerError:
      description: Unexpected error. Retry with the same idempotency key where one applies.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: internal error
  securitySchemes:
    AuthID:
      type: apiKey
      in: header
      name: X-Auth-ID
      description: Your Vobiz account Auth ID (`MA_XXXXXXXX`).
    AuthToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Your Vobiz account Auth Token.

````

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