Developer API

API Reference

Build powerful integrations with the NuLink REST API. Full documentation for all endpoints.

Quick Start

Get started with the NuLink API in minutes.

# Base URL

https://api.nulink.app/v1

# Authentication Header

Authorization: Bearer YOUR_API_KEY

Get API Key View SDK Libraries

API Endpoints

Authentication

POST/api/auth/registerRegister a new user account

POST/api/auth/loginAuthenticate and get access token

POST/api/auth/refreshRefresh access token

POST/api/auth/logoutInvalidate current session

Phone Numbers

GET/api/phone-numbers/searchSearch available numbers

POST/api/phone-numbers/purchasePurchase a phone number

GET/api/phone-numbersList your phone numbers

DELETE/api/phone-numbers/:idRelease a phone number

Voice Calls

POST/api/calls/dialInitiate an outbound call

POST/api/calls/:id/hangupEnd an active call

POST/api/calls/:id/transferTransfer a call

GET/api/calls/historyGet call history

Messaging

POST/api/messages/sendSend an SMS/MMS message

GET/api/messages/conversationsList conversations

GET/api/messages/conversations/:idGet conversation messages

Fax

POST/api/fax/sendSend a fax

GET/api/fax/inboxList received faxes

GET/api/fax/outboxList sent faxes

Contacts

GET/api/contactsList all contacts

POST/api/contactsCreate a new contact

PUT/api/contacts/:idUpdate a contact

DELETE/api/contacts/:idDelete a contact

Official SDKs

🟢

Node.js

Available

🐍

Python

Available

🐘

PHP

Coming Soon

💎

Ruby

Coming Soon

Back to Home