> ## Documentation Index > Fetch the complete documentation index at: https://leadping.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get organization phone number provider status > Returns provider and Leadping status for a phone number, including messaging warmup, assignments, and verification state. ## OpenAPI ````yaml /openapi.json get /phone-numbers/{phoneNumber}/status openapi: 3.1.1 info: title: Leadping API description: >- The Leadping API helps businesses capture and manage leads, automate follow-up, send SMS and MMS messages, place calls, track conversations, enforce contact suppression, and analyze communication workflows. Use this OpenAPI 3.1 contract to integrate lead sources, build organization tools, or generate a typed API client. Authenticate protected operations with a Leadping user access token or WorkOS organization API key. Lead intake operations also accept a Leadping source key. termsOfService: https://leadping.ai/docs/terms-of-service contact: name: Leadping Support url: https://leadping.ai/contact email: support@leadping.ai license: name: MIT url: https://opensource.org/licenses/MIT version: v1 summary: Lead management, messaging, calling, and automation API servers: - url: https://api.leadping.ai description: Production security: [] tags: - name: leadping.Api description: >- Agent-to-agent discovery and request handling for Leadping's supported AI agent integrations. - name: Analytics description: >- Provides lead, communication, conversion, and organization performance analytics. Use these endpoints to measure activity over time, compare outcomes, and power operational dashboards and reporting workflows. - name: Automations description: >- Manages automated lead follow-up workflows and their execution history. Use these endpoints to configure SMS automation steps, preview eligible leads, run workflows, and inspect individual automation executions. - name: BlogArticles description: >- Provides published Leadping blog content. Use these endpoints to list published articles and retrieve an individual article by its public slug. - name: Conversations description: >- Provides lead conversation timelines and inbox-oriented conversation views. Use these endpoints to list recent conversations and retrieve the cross-channel communication history associated with a lead. - name: Feedback description: >- Captures Leadping product feedback and supports administrative triage. Users can submit feedback, while authorized staff can search, inspect, classify, and update feedback throughout the review process. - name: Leads description: >- Manages lead intake, records, assignment, routing, and lifecycle operations. Use these endpoints to ingest leads from trusted sources, search and update lead records, manage ownership and tags, and archive or delete leads. - name: LeadStatusChanges description: >- Manages the auditable history of lead status transitions. Use these endpoints to change a lead's status, correct transition records, search status history, and export status activity for reporting. - name: LeadStatuses description: >- Manages the lead statuses used to classify and track leads throughout their lifecycle. Use these endpoints to list, create, update, and archive organization-specific lead statuses for consistent pipeline organization and reporting. - name: Notifications description: >- Manages user notifications, announcements, and push-notification installations. Use these endpoints to retrieve notification feeds and unread counts, update read state, and register or remove client push installations. - name: OutboundDelivery description: >- Reports outbound delivery pacing and sending capacity for the current organization. Use these endpoints to determine whether outbound communications can proceed and to understand active throttles, limits, or capacity constraints. - name: Sources description: >- Manages lead sources, intake credentials, routing defaults, and attribution. Use these endpoints to create and configure sources, search source records, inspect source activity, rotate intake access, and remove obsolete sources. - name: Suppressions description: >- Manages recipient suppression state for compliant Leadping communication workflows. Use these endpoints to check contact eligibility, record or release suppressions, and review suppression history before sending messages or placing calls. - name: Tags description: >- Manages organization-defined tags for categorizing and routing leads. Use these endpoints to list, create, update, and archive reusable tags that support lead filtering, automation, assignment, and reporting. - name: Users description: >- Manages the current Leadping user's profile, preferences, setup, and account workflows. Use these endpoints to retrieve and update user data, configure communication and compliance preferences, complete onboarding, manage plan-related actions, and request account operations. - name: Calls description: >- Manages outbound Leadping calls and active call-control workflows. Use these endpoints to initiate or cancel a call, retrieve call state, and transfer an active call within supported telephony flows. - name: PhoneNumbers description: >- Manages phone-number discovery, purchasing, assignment, configuration, and compliance. Use these endpoints to search available numbers, manage owned numbers and caller identity, configure messaging or voice behavior, and monitor registration and warmup state. - name: Sms description: >- Sends and manages SMS and MMS communications through Leadping. Use these endpoints to send messages, upload MMS media, and cancel eligible scheduled messages while preserving conversation and delivery tracking. - name: Telephony description: >- Provides shared authentication and bootstrap data for Leadping telephony clients. Use this endpoint to obtain the scoped credentials and configuration required to initialize supported calling experiences. - name: Organizations description: >- Manages Leadping organizations, memberships, invitations, settings, and API credentials. Use these endpoints to maintain organization profiles and branding, manage members and invitations, configure options, and issue or revoke organization API keys. - name: UserDataExports description: >- Creates and delivers user-requested exports of Leadping account data. Use these endpoints to request an export, monitor its preparation status, and download the completed archive through a time-limited redirect. - name: CallEvents description: >- Provides call event records for auditing, diagnostics, and reporting. Use these endpoints to search and inspect lifecycle events emitted as Leadping calls are initiated, connected, completed, or fail. - name: Events description: >- Provides a unified record of Leadping activity across communication channels. Use these endpoints to retrieve event timelines, search event history, inspect event details, and record supported application events. - name: SmsEvents description: >- Provides SMS and MMS event records for delivery tracking and diagnostics. Use these endpoints to search and inspect message lifecycle events, including outbound delivery updates and inbound messaging activity. - name: PaymentMethods description: >- Manages organization payment methods and billing invoices. Use these endpoints to add, confirm, inspect, and remove payment methods or retrieve invoices associated with the current organization's billing account. - name: Transactions description: >- Provides organization wallet and billing transaction records. Use these endpoints to search transaction history, inspect individual charges or credits, review transaction summaries, and issue administrative credits. - name: Usage description: >- Provides billable usage records for Leadping services. Use these endpoints to review messaging and calling consumption, inspect usage summaries, and reconcile provider activity for an organization. - name: Wallets description: >- Manages organization wallet balances, funding, and credit activity. Use these endpoints to inspect wallet state and history, configure wallet behavior, add funds, and record credits or adjustments. externalDocs: description: >- Leadping API documentation, authentication guide, concepts, and integration guidance. url: https://leadping.ai/docs/api-reference paths: /phone-numbers/{phoneNumber}/status: get: tags: - PhoneNumbers summary: Get organization phone number provider status description: >- Returns provider and Leadping status for a phone number, including messaging warmup, assignments, and verification state. operationId: PhoneNumbers_GetStatus parameters: - name: phoneNumber in: path description: The phone number to check the status for. required: true schema: type: string - name: windowDays in: query description: The window days. schema: type: - 'null' - integer format: int32 - name: startDate in: query description: The start date. schema: type: string format: date - name: endDate in: query description: The end date. schema: type: string format: date responses: '200': description: Phone number status was successfully retrieved. content: application/json: schema: allOf: - $ref: '#/components/schemas/PhoneNumberStatusResponse' description: >- Describes a phone number's current warmup stage, limits, progress, and readiness for production traffic. '400': description: The request was invalid or malformed. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Bad Request status: 400 detail: The request could not be completed. '401': description: Authentication credentials are missing or invalid. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Unauthorized status: 401 detail: The request could not be completed. '403': description: >- The authenticated user or organization does not have permission to perform this operation. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Forbidden status: 403 detail: The request could not be completed. '429': description: The API rate limit for this account or client has been exceeded. headers: Retry-After: description: Number of seconds to wait before retrying the request. schema: minimum: 0 type: integer format: int32 content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Too Many Requests status: 429 detail: The request could not be completed. '500': description: An internal server error occurred. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/ProblemDetails' description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. example: type: about:blank title: Internal Server Error status: 500 detail: The request could not be completed. security: - Bearer: [] components: schemas: PhoneNumberStatusResponse: type: object properties: number: type: string description: E.164 phone number exposed by this phone number warmup status. messagesPossible: type: integer description: Indicates whether this phone number can currently send SMS messages. format: int32 callsPossible: type: integer description: >- Indicates whether this phone number can currently place outbound calls. format: int32 smsWarmup: type: - 'null' - object allOf: - $ref: '#/components/schemas/SmsReadinessStatusResponse' description: SMS warmup status for this phone number. outboundCapacity: type: - 'null' - object allOf: - $ref: '#/components/schemas/OutboundPhoneNumberCapacity' description: Current outbound SMS and voice capacity for this phone number. optOutMetrics: allOf: - $ref: '#/components/schemas/PhoneNumberOptOutMetricsResponse' description: >- Recent SMS opt-out metrics used to evaluate sender health and compliance risk. trafficMetrics: allOf: - $ref: '#/components/schemas/PhoneNumberTrafficMetricsResponse' description: Phone number traffic metrics for recent SMS and call activity. recentEvents: type: array items: allOf: - $ref: '#/components/schemas/PhoneNumberMessagingEventResponse' description: >- Describes a messaging event used to calculate delivery, failure, and opt-out metrics for a phone number. description: Recent workflow events returned for timeline and troubleshooting. description: >- Describes a phone number's current warmup stage, limits, progress, and readiness for production traffic. ProblemDetails: type: object properties: type: type: - 'null' - string description: URI reference that identifies the problem type. title: type: - 'null' - string description: Short, human-readable summary of the problem. status: type: - 'null' - integer description: HTTP status code returned for the problem. format: int32 detail: type: - 'null' - string description: >- Human-readable explanation specific to this occurrence of the problem. instance: type: - 'null' - string description: >- URI reference that identifies this specific occurrence of the problem. errors: type: object additionalProperties: type: array items: type: string description: >- Validation errors keyed by the JSON request field name. Present for request validation failures. traceId: type: string description: >- Request trace identifier used to correlate this problem with Leadping diagnostics. description: >- Standard problem-details response containing machine-readable and human-readable information about an HTTP API error. SmsReadinessStatusResponse: type: object properties: phoneNumberId: type: string description: The phone number ID associated with this SMS warmup status. phoneNumber: type: string description: The phone number associated with this SMS warmup status. status: allOf: - $ref: '#/components/schemas/SmsReadinessState' description: The current state for this SMS warmup status. healthStatus: allOf: - $ref: '#/components/schemas/SmsReadinessHealthStatus' description: The current delivery-health assessment for this SMS warmup status. healthScore: type: integer description: The health score metric for this SMS warmup status. format: int32 progressPercent: type: integer description: The progress percent metric for this SMS warmup status. format: int32 warmupEnabled: type: boolean description: Whether warmup is enabled for this SMS warmup status. uiState: allOf: - $ref: '#/components/schemas/SmsReadinessUiState' description: The current UI state for this SMS warmup status. description: Describes SMS warmup status data returned by Leadping. OutboundPhoneNumberCapacity: type: object properties: capacityAvailable: type: boolean description: >- Indicates whether Leadping successfully calculated capacity for this phone number. phoneNumberId: type: - 'null' - string description: >- Unique identifier of the phone number associated with this Leadping outbound phone number capacity. phoneNumber: type: - 'null' - string description: >- Phone number associated with this Leadping outbound phone number capacity. healthStatus: allOf: - $ref: '#/components/schemas/PhoneNumberOutboundHealthStatus' description: >- Current health status for this Leadping outbound phone number capacity. healthReason: type: - 'null' - string description: Human-readable reason for the current phone-number health state. smsApproved: type: boolean description: >- Indicates whether this phone number has an approved 10DLC messaging campaign assignment. smsRamping: type: boolean description: >- Indicates whether SMS limits for this phone number are still ramping up. smsRemainingThisMinute: type: integer description: SMS remaining in the current rolling minute. format: int32 smsUsedThisMinute: type: integer description: SMS used in the current rolling minute. format: int32 smsLimitThisMinute: type: integer description: SMS limit for one rolling minute. format: int32 smsMinutelyResetsAt: type: - 'null' - string description: >- The next time SMS capacity becomes available in the rolling minute window. format: date-time smsRemainingToday: type: integer description: >- SMS remaining today for the applicable messaging or voice capacity window. format: int32 smsUsedToday: type: integer description: >- SMS used today for the applicable messaging or voice capacity window. format: int32 smsLimitToday: type: integer description: >- Number of SMS limit today represented by this Leadping outbound phone number capacity. format: int32 smsDailyResetsAt: type: - 'null' - string description: Next midnight Eastern time, when SMS daily capacity resets. format: date-time smsRemainingThisHour: type: integer description: >- SMS remaining this hour for the applicable messaging or voice capacity window. format: int32 smsUsedThisHour: type: integer description: >- SMS used this hour for the applicable messaging or voice capacity window. format: int32 smsLimitThisHour: type: integer description: >- Number of SMS limit this hour represented by this Leadping outbound phone number capacity. format: int32 smsHourlyResetsAt: type: - 'null' - string description: >- Start of the next Eastern time hour, when SMS hourly capacity resets. format: date-time voiceRamping: type: boolean description: >- Indicates whether call limits for this phone number are still ramping up. voiceRemainingThisMinute: type: integer description: Voice remaining in the current rolling minute. format: int32 voiceUsedThisMinute: type: integer description: Voice used in the current rolling minute. format: int32 voiceLimitThisMinute: type: integer description: Voice limit for one rolling minute. format: int32 voiceMinutelyResetsAt: type: - 'null' - string description: >- The next time voice capacity becomes available in the rolling minute window. format: date-time voiceRemainingToday: type: integer description: >- Voice remaining today for the applicable messaging or voice capacity window. format: int32 voiceUsedToday: type: integer description: >- Voice used today for the applicable messaging or voice capacity window. format: int32 voiceLimitToday: type: integer description: >- Voice limit today associated with this Leadping outbound phone number capacity. format: int32 voiceDailyResetsAt: type: - 'null' - string description: Next midnight Eastern time, when voice daily capacity resets. format: date-time voiceRemainingThisHour: type: integer description: >- Voice remaining this hour for the applicable messaging or voice capacity window. format: int32 voiceUsedThisHour: type: integer description: >- Voice used this hour for the applicable messaging or voice capacity window. format: int32 voiceLimitThisHour: type: integer description: >- Voice limit this hour associated with this Leadping outbound phone number capacity. format: int32 voiceHourlyResetsAt: type: - 'null' - string description: >- Start of the next Eastern time hour, when voice hourly capacity resets. format: date-time description: >- Reports the sending capacity, current load, and availability of a phone number considered for outbound delivery. PhoneNumberOptOutMetricsResponse: type: object properties: windowDays: type: integer description: Number of days included in the metrics reporting window. format: int32 windowStartedAt: type: string description: UTC timestamp when the metrics reporting window starts. format: date-time distinctContactedCount: type: integer description: Number of distinct recipients contacted during this metrics window. format: int32 optOutCount: type: integer description: Number of recipients who opted out during this metrics window. format: int32 optOutRatePercent: type: number description: >- Percentage of contacted recipients who opted out during this metrics window. format: double description: Describes phone number opt-out metrics data returned by Leadping. PhoneNumberTrafficMetricsResponse: type: object properties: windowDays: type: integer description: Number of days included in the metrics reporting window. format: int32 windowStartedAt: type: string description: UTC timestamp when the metrics reporting window starts. format: date-time smsSentCount: type: integer description: Number of SMS messages sent during this metrics window. format: int32 smsFailedCount: type: integer description: Number of SMS messages that failed during this metrics window. format: int32 mmsSentCount: type: integer description: Number of MMS messages sent during this metrics window. format: int32 mmsFailedCount: type: integer description: Number of MMS messages that failed during this metrics window. format: int32 callPlacedCount: type: integer description: Number of outbound calls placed during this metrics window. format: int32 callFailedCount: type: integer description: Number of outbound calls that failed during this metrics window. format: int32 callConnectedCount: type: integer description: Number of outbound calls that connected during this metrics window. format: int32 callShortCount: type: integer description: >- Number of connected outbound calls shorter than 30 seconds during this metrics window. format: int32 callInvalidNumberCount: type: integer description: >- Number of outbound calls that failed because the destination number was invalid during this metrics window. format: int32 trend: type: array items: allOf: - $ref: '#/components/schemas/PhoneNumberTrafficTrendPoint' description: >- Time-series data point schema for Leadping API phone number traffic trend bucket charts and metrics. description: >- Time-series buckets that show how the metric changes across the reporting window. description: Describes phone number traffic metrics data returned by Leadping. PhoneNumberMessagingEventResponse: type: object properties: id: type: string description: Unique Leadping identifier for this phone number messaging event. createdAt: type: string description: UTC timestamp when this phone number messaging event was created. format: date-time label: type: string description: >- Short display label for this phone number messaging event, formatted for charts, filters, or list views. eventType: type: string description: >- Event type used to classify this timeline, SMS, call, or automation event. direction: type: string description: >- Communication direction for this phone number messaging event, such as inbound or outbound. fromPhoneNumber: type: string description: Sender phone number used for this communication. toPhoneNumber: type: string description: Recipient phone number used for this communication. textPreview: type: string description: >- Short preview of the SMS or conversation text for this phone number messaging event. isOptOut: type: boolean description: >- Indicates whether the recipient has opted out of further SMS communication. description: >- Describes a messaging event used to calculate delivery, failure, and opt-out metrics for a phone number. SmsReadinessState: enum: - Not Started - In Progress - Paused - Blocked - Ready type: string description: >- Describes whether an organization is configured and permitted to send SMS or MMS traffic through Leadping. SmsReadinessHealthStatus: enum: - Not Evaluated - Evaluating - Healthy - Needs Attention - Blocked type: string description: >- Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic. SmsReadinessUiState: type: object properties: label: allOf: - $ref: '#/components/schemas/SmsReadinessState' description: The human-readable label shown for this SMS readiness UI state. tone: type: string description: Tone for this SMS readiness UI state. description: type: string description: The human-readable description of this SMS readiness UI state. description: >- Describes SMS readiness UI state data used in Leadping API requests and responses. PhoneNumberOutboundHealthStatus: enum: - unknown - new - healthy - warmup - limited - cooling_down - suspended - disabled type: string description: Defines phone-number outbound health states used by pacing. PhoneNumberTrafficTrendPoint: type: object properties: startAt: type: string description: UTC timestamp when this reporting bucket starts. format: date-time endAt: type: string description: UTC timestamp when this reporting bucket ends. format: date-time label: type: string description: >- Short display label for this phone number traffic trend bucket, formatted for charts, filters, or list views. smsSentCount: type: integer description: Number of SMS messages sent during this metrics window. format: int32 smsFailedCount: type: integer description: Number of SMS messages that failed during this metrics window. format: int32 mmsSentCount: type: integer description: Number of MMS messages sent during this metrics window. format: int32 mmsFailedCount: type: integer description: Number of MMS messages that failed during this metrics window. format: int32 callPlacedCount: type: integer description: Number of outbound calls placed during this metrics window. format: int32 callFailedCount: type: integer description: Number of outbound calls that failed during this metrics window. format: int32 description: >- Time-series data point schema for Leadping API phone number traffic trend bucket charts and metrics. securitySchemes: Bearer: type: http description: >- Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_. scheme: bearer bearerFormat: JWT or organization API key ````