Developer Resources · REST API

Build on the PrimeCall API.

A REST API for provisioning, calls, messaging, and account management. Every request is authenticated with a bearer token and returns JSON.

Open full API reference ↗ Get an API key

Base URL

https://{server}/ns-api/v2

Authentication

Bearer token

Format

JSON

GET /version

Read API Version

Returns the API version running on the connected server along with its hostname. No parameters required — useful as a lightweight health check or for confirming which server your integration is talking to.

{{ currentCode }}

Example response · 200

{
  "apiversion": "44.4.1",
  "hostname": "ns-api.com"
}

Responses

200 OK

apiversion string

The version the API is currently running.

hostname string

The hostname of the server connected to.

400 Bad Request

code integer

The HTTP error code returned.

message string

Details on the error and any correction steps.

401 Authentication Required

code integer

The HTTP error code returned.

message string

Details on the error and any correction steps.

404 Record Not Found

code integer

The HTTP error code returned.

message string

Details on the error and any correction steps.

Looking for the complete reference?

Users, calls, messaging, call queues, recordings, and 200+ more endpoints.

Full API docs ↗