List entry points

GET

entry-points

List entry points

curl --request GET \
  --url https://api.getnexor.ai/api/public/entry-points \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.getnexor.ai/api/public/entry-points', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getnexor.ai/api/public/entry-points",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getnexor.ai/api/public/entry-points"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getnexor.ai/api/public/entry-points")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "entry_points": [
    {
      "channel": "whatsapp",
      "id": "44444444-4444-4444-8444-444444444444",
      "handle": "+56911111111",
      "label": "Main",
      "active": true,
      "country": null,
      "destination": {
        "type": "group",
        "id": "11111111-1111-4111-8111-111111111111",
        "name": "Inbound"
      },
      "available": true,
      "unavailable_reason": null
    },
    {
      "channel": "phone",
      "id": "55555555-5555-4555-8555-555555555555",
      "handle": "+56222222222",
      "label": "Calls",
      "active": true,
      "country": "CL",
      "destination": null,
      "available": true,
      "unavailable_reason": null,
      "inbound_enabled": false,
      "managed_by_ops": false,
      "assignment": {
        "status": "pending",
        "destination": {
          "type": "group",
          "id": "11111111-1111-4111-8111-111111111111",
          "name": "Inbound"
        },
        "requested_at": "2026-10-12T15:04:05.000Z",
        "error_code": null
      }
    },
    {
      "channel": "webchat",
      "id": "webchat:11111111-1111-4111-8111-111111111111",
      "handle": null,
      "label": null,
      "active": true,
      "country": null,
      "destination": null,
      "available": true,
      "unavailable_reason": null,
      "ambient": true,
      "enabled": false
    }
  ]
}

{
  "error": "inbound_router_not_enabled"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "Forbidden",
  "message": "This API key is missing the required scope: workflows:write"
}

{
  "error": "agent_group_not_found"
}

{
  "error": "internal_error"
}

An entry point is a place where leads reach you: a WhatsApp number, an iMessage number, a personal WhatsApp line, a phone number for calls, SMS, an Instagram or Messenger account, an email sender, or the web chat.

This is not the task marked Entry point when you test an agent. That label is about tasks; this endpoint is about numbers, accounts, and inboxes.

destination says who answers each entry point. Its types use older names:

`destination.type`	Who answers
`group`	An agent (`master_workflow`). Its inbound router picks the task.
`agent`	One task (`workflow`).
`null`	Nobody.

With master_workflow_id, the list is seen from that agent:

available: false and unavailable_reason explain why an entry point cannot be connected to it.
The agent’s email and web chat appear with ambient: true. They belong to the whole agent, and enabled says whether the agent answers there.
The account needs the inbound router, otherwise 400 inbound_router_not_enabled.

Phone numbers

Phone numbers carry three more fields:

Field	Meaning
`inbound_enabled`	Whether the number answers incoming calls.
`managed_by_ops`	The Nexor team manages this number. Moving or disconnecting it can be refused with 409 `number_managed_by_ops_pool`.
`assignment`	A connection to an agent that Nexor is still finishing, or that stopped. `null` when there is none.

When present, assignment has status, destination (the agent the number is being connected to), requested_at, and error_code:

`assignment.status`	Meaning
`pending`	Nexor is still connecting the number, for example while the agent is prepared for calls. It finishes on its own; `assignment` becomes `null` once the number answers calls.
`failed`	The connection stopped. `error_code` says why, for example `phone_inbound_assignment_timeout` when the number was still not answering 10 minutes after the request. Fix the cause and send the change again.

See When the agent is still being prepared for calls. To change a destination, use Set destination.

Authorizations

X-API-Key

string

header

required

API key for authentication. Keys are prefixed with nxr_live_. To work inside a sub-account with a main account key, also send the optional X-Nexor-Sub-Account-Id header.

Query Parameters

master_workflow_id

string<uuid>

Optional agent ID. Shows the entry points from that agent's point of view.

Response

Entry points of the account.

entry_points

object[]

required

Show child attributes

Last modified on October 13, 2026

List entry points

curl --request GET \
  --url https://api.getnexor.ai/api/public/entry-points \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.getnexor.ai/api/public/entry-points', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getnexor.ai/api/public/entry-points",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getnexor.ai/api/public/entry-points"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getnexor.ai/api/public/entry-points")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "entry_points": [
    {
      "channel": "whatsapp",
      "id": "44444444-4444-4444-8444-444444444444",
      "handle": "+56911111111",
      "label": "Main",
      "active": true,
      "country": null,
      "destination": {
        "type": "group",
        "id": "11111111-1111-4111-8111-111111111111",
        "name": "Inbound"
      },
      "available": true,
      "unavailable_reason": null
    },
    {
      "channel": "phone",
      "id": "55555555-5555-4555-8555-555555555555",
      "handle": "+56222222222",
      "label": "Calls",
      "active": true,
      "country": "CL",
      "destination": null,
      "available": true,
      "unavailable_reason": null,
      "inbound_enabled": false,
      "managed_by_ops": false,
      "assignment": {
        "status": "pending",
        "destination": {
          "type": "group",
          "id": "11111111-1111-4111-8111-111111111111",
          "name": "Inbound"
        },
        "requested_at": "2026-10-12T15:04:05.000Z",
        "error_code": null
      }
    },
    {
      "channel": "webchat",
      "id": "webchat:11111111-1111-4111-8111-111111111111",
      "handle": null,
      "label": null,
      "active": true,
      "country": null,
      "destination": null,
      "available": true,
      "unavailable_reason": null,
      "ambient": true,
      "enabled": false
    }
  ]
}

{
  "error": "inbound_router_not_enabled"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "Forbidden",
  "message": "This API key is missing the required scope: workflows:write"
}

{
  "error": "agent_group_not_found"
}

{
  "error": "internal_error"
}

Start here

Quickstart

API reference

Build and launch

WhatsApp

Channels

Agents

Meetings

Integrations

Account

Inbox

Insights

Developer tools

Support reference

List entry points

Phone numbers

Authorizations

Query Parameters

Response