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

# API status

> Whether the API is up. Needs no API key, touches no data and is never billed, so it suits uptime monitors and a "test connection" button. It does not check that your key works: call `GET /v1/me` for that.



## OpenAPI

````yaml /openapi.json get /v1
openapi: 3.1.0
info:
  title: LumisReach v1 API
  version: 1.0.0
  description: >-
    Programmatic access to the LumisReach voice platform — calls, numbers,
    caller trust, and brands.
  contact:
    name: LumisReach
    email: founders@lumisreach.com
servers:
  - url: https://api.lumisreach.com/api
security:
  - bearerAuth: []
tags:
  - name: Contacts
  - name: Calls
  - name: Messages
  - name: Emails
  - name: Phone Numbers
  - name: Caller IDs
  - name: Enterprise Registration
  - name: Branded Calling
  - name: Dialer Calls
  - name: SMS
  - name: WebRTC
  - name: Reputation
  - name: Usage
  - name: Account
  - name: Billing
  - name: Documents
  - name: Lincoln AI
  - name: Quick Agent Actions
  - name: Sub-entities
  - name: Video schedules
  - name: Videos
paths:
  /v1:
    get:
      tags:
        - Account
      summary: API status
      description: >-
        Whether the API is up. Needs no API key, touches no data and is never
        billed, so it suits uptime monitors and a "test connection" button. It
        does not check that your key works: call `GET /v1/me` for that.
      operationId: v1_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: http://json-schema.org/draft-07/schema#
                type: object
                properties:
                  status:
                    type: string
                    const: ok
                  service:
                    type: string
                  version:
                    type: string
                    const: v1
                  timestamp:
                    type: string
                    description: Server time (ISO 8601)
                  docs:
                    type: string
                  openapi:
                    type: string
                    description: This API's OpenAPI document
                required:
                  - status
                  - service
                  - version
                  - timestamp
                  - docs
                  - openapi
                additionalProperties: false
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````