List sub-accounts

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

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

fetch('https://api.getnexor.ai/api/public/sub-accounts', 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/sub-accounts",
  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/sub-accounts"

	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/sub-accounts")

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

{
  "period": {
    "start": "2026-10-01T00:00:00.000Z",
    "end": "2026-11-01T00:00:00.000Z",
    "source": "subscription"
  },
  "family": {
    "used": 412,
    "quota": 5000,
    "overageCount": 0,
    "pricePerUnit": 0.5
  },
  "items": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "name": "Partner Andes",
      "country": "CL",
      "created_at": "2026-09-30T14:02:11.000Z",
      "deactivated_at": null,
      "owner": {
        "email": "ana@partner.example",
        "name": "Ana Pérez",
        "accepted_at": "2026-09-30T15:10:00.000Z"
      },
      "agents_active": 2,
      "agents_total": 3,
      "leads_total": 860,
      "contacted_period": 137,
      "state": "active"
    },
    {
      "id": "22222222-2222-4222-8222-222222222222",
      "name": "Partner Lima",
      "country": "PE",
      "created_at": "2026-09-30T16:40:00.000Z",
      "deactivated_at": null,
      "owner": {
        "email": "luis@partner.example",
        "name": "Luis Rojas",
        "accepted_at": null,
        "invitation_expires_at": "2026-10-07T16:40:00.000Z"
      },
      "agents_active": 0,
      "agents_total": 0,
      "leads_total": 0,
      "contacted_period": 0,
      "state": "invited"
    }
  ]
}

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

{
  "error": "sub_accounts_not_enabled"
}

{
  "error": "internal_error"
}

GET

sub-accounts

List sub-accounts

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

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

fetch('https://api.getnexor.ai/api/public/sub-accounts', 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/sub-accounts",
  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/sub-accounts"

	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/sub-accounts")

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

{
  "period": {
    "start": "2026-10-01T00:00:00.000Z",
    "end": "2026-11-01T00:00:00.000Z",
    "source": "subscription"
  },
  "family": {
    "used": 412,
    "quota": 5000,
    "overageCount": 0,
    "pricePerUnit": 0.5
  },
  "items": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "name": "Partner Andes",
      "country": "CL",
      "created_at": "2026-09-30T14:02:11.000Z",
      "deactivated_at": null,
      "owner": {
        "email": "ana@partner.example",
        "name": "Ana Pérez",
        "accepted_at": "2026-09-30T15:10:00.000Z"
      },
      "agents_active": 2,
      "agents_total": 3,
      "leads_total": 860,
      "contacted_period": 137,
      "state": "active"
    },
    {
      "id": "22222222-2222-4222-8222-222222222222",
      "name": "Partner Lima",
      "country": "PE",
      "created_at": "2026-09-30T16:40:00.000Z",
      "deactivated_at": null,
      "owner": {
        "email": "luis@partner.example",
        "name": "Luis Rojas",
        "accepted_at": null,
        "invitation_expires_at": "2026-10-07T16:40:00.000Z"
      },
      "agents_active": 0,
      "agents_total": 0,
      "leads_total": 0,
      "contacted_period": 0,
      "state": "invited"
    }
  ]
}

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

{
  "error": "sub_accounts_not_enabled"
}

{
  "error": "internal_error"
}

A sub-account is a separate Nexor account that belongs to your account. It has its own team, agents, numbers, conversations, and leads, and every lead it contacts counts toward your plan. See Sub-accounts. The main account is always the account that owns the API key. There is no parameter to act on behalf of another account.

Read the response

`state`	Meaning
`active`	The sub-account is working normally.
`invited`	The owner has not joined yet. `owner.invitation_expires_at` shows when the invitation expires.
`paused`	The sub-account has tasks and none of them is live.
`inactive`	The sub-account was deactivated. Its team cannot see it.

agents_active and agents_total count tasks (workflow in the API), not agents.
contacted_period is what one sub-account contacted this period. family.used adds up the main account and all its sub-accounts, and is the number compared with family.quota.
null in period, family, or contacted_period means the usage meter could not be read. It does not mean zero.

Before you start

Sub-accounts are an optional feature that Nexor enables on request. Without it, every endpoint in this section returns 403 sub_accounts_not_enabled. Contact Nexor Support to request it.
Use an API key of the main account. A key that belongs to a sub-account gets 403 sub_account_cannot_manage_sub_accounts, because a sub-account cannot have sub-accounts of its own.
MCP keys need sub-accounts:read to list and sub-accounts:write for every other operation. Full-access API keys need nothing else.
Every change requires "confirm": true in the body. Without it, the API returns 400 confirmation_required and changes nothing.
An ID that is not one of your sub-accounts returns 403 not_parent_of_client.
Errors return a stable code in error, such as owner_email_invalid. Map the code to your own message.

Authorizations

X-API-Key

string

header

required

API key for authentication. Keys are prefixed with nxr_live_.

Response

Sub-accounts and family usage.

period

object | null

required

The main account's current usage period. null when the usage meter could not be read.

Show child attributes

family

object | null

required

Usage of the main account plus all its sub-accounts. null when the usage meter could not be read.

Show child attributes

items

object[]

required

Show child attributes

Last modified on October 1, 2026

Start here

Quickstart

API reference

Build and launch

WhatsApp

Channels

Agents

Meetings

Integrations

Account

Inbox

Developer tools

Support reference

List sub-accounts

Read the response

Before you start

Authorizations

Response

​Read the response

​Before you start

Authorizations

Response

Read the response

Before you start