Introduction
Overview of the PhoneLine+ Partner API
Please find V1 documentation here: https://phonelineplus.readme.io/v1.0
The PhoneLine+ Partner API lets partners manage customers, users, phone numbers, hardware orders, and webhooks programmatically.
Base URL
https://api.phonelineplus.com/v2All paths in this documentation are relative to that base URL (for example, GET /customers means GET https://api.phonelineplus.com/v2/customers).
API Reference vs Guides
| Section | Purpose |
|---|---|
| Reference | Generated from OpenAPI — every endpoint, parameter, and schema |
| Guides | Concepts, workflows, and constraints (this section) |
Use Reference for field-level detail; use Guides for end-to-end flows.
Resource overview
| Concept | Endpoints |
|---|---|
| Customer (company) | /customers |
| Users | /customers/{customerID}/users |
| Numbers | /customers/{customerID}/numbers, /numbers/area-codes |
| Contract changes | PATCH /customers/{customerID}/contract (async job) |
| Hardware orders | /customers/{customerID}/orders, /products |
| Background work | /jobs |
| Notifications | /webhooks |
| UK addresses | /addresses/lookup |
Authentication
Every endpoint except POST /auth requires a Bearer JWT. See Authentication.
Async operations
Creating a customer, deleting a customer, and updating a contract return a jobID immediately. Poll /jobs (or use webhooks) for completion. See Async jobs.
Sandbox
For integration testing, use https://api.phonelineplus.com/sandbox with the same POST /auth → Bearer JWT flow and separate sandbox API keys — see Sandbox and Authentication.
Next steps
- Authentication — obtain and use a JWT
- Onboarding a customer — first integration flow
- Async jobs — track background work
Updated 23 days ago