Associate contacts with an entity

curl --request POST \
  --url https://api.nova.net/v1/entities/{ent_id}/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": "cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI"
  }
]
'

import requests

url = "https://api.nova.net/v1/entities/{ent_id}/contacts"

payload = [{ "id": "cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI" }]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([{id: 'cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI'}])
};

fetch('https://api.nova.net/v1/entities/{ent_id}/contacts', 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.nova.net/v1/entities/{ent_id}/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'id' => 'cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.nova.net/v1/entities/{ent_id}/contacts"

	payload := strings.NewReader("[\n  {\n    \"id\": \"cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI\"\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nova.net/v1/entities/{ent_id}/contacts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"id\": \"cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nova.net/v1/entities/{ent_id}/contacts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"id\": \"cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI\"\n  }\n]"

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

{
  "object": "list",
  "data": [
    {
      "object": "contact",
      "livemode": true,
      "id": "cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI",
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "external_reference": "contact-123"
    }
  ],
  "next_page_url": "/v1/contacts?page=page_5dr8SFDbv7rZ2aj4&limit=10",
  "previous_page_url": "/v1/contacts?page_before=page_8VtqLBv3xJpY7mk2&limit=10",
  "has_more": true,
  "url": "/v1/contacts"
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

POST

entities

{ent_id}

contacts

Associate contacts with an entity

curl --request POST \
  --url https://api.nova.net/v1/entities/{ent_id}/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": "cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI"
  }
]
'

import requests

url = "https://api.nova.net/v1/entities/{ent_id}/contacts"

payload = [{ "id": "cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI" }]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([{id: 'cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI'}])
};

fetch('https://api.nova.net/v1/entities/{ent_id}/contacts', 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.nova.net/v1/entities/{ent_id}/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'id' => 'cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.nova.net/v1/entities/{ent_id}/contacts"

	payload := strings.NewReader("[\n  {\n    \"id\": \"cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI\"\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nova.net/v1/entities/{ent_id}/contacts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"id\": \"cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nova.net/v1/entities/{ent_id}/contacts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"id\": \"cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI\"\n  }\n]"

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

{
  "object": "list",
  "data": [
    {
      "object": "contact",
      "livemode": true,
      "id": "cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI",
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "external_reference": "contact-123"
    }
  ],
  "next_page_url": "/v1/contacts?page=page_5dr8SFDbv7rZ2aj4&limit=10",
  "previous_page_url": "/v1/contacts?page_before=page_8VtqLBv3xJpY7mk2&limit=10",
  "has_more": true,
  "url": "/v1/contacts"
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid_integer",
  "message": "One or more fields failed validation.",
  "status": 400,
  "doc_url": "https://docs.nova.net/errors/parameter_invalid_integer",
  "invalid-params": [
    {
      "code": "parameter_invalid_integer",
      "name": "query.limit",
      "value": 200,
      "reason": "Too big: expected number to be <=100"
    }
  ]
}

Authorizations

Authorization

string

header

required

OAuth2 client_credentials grant for server-to-server access. Onboard via your Nova admin to receive a client_id and client_secret, then POST /oauth/token to exchange them for a short-lived access token. Send the token as Authorization: Bearer <access_token> on every authenticated request. Tokens expire after 3600 seconds — refresh by re-exchanging credentials.

Headers

X-Organization-Id

string

ID of the organization the request acts on. Optional when the access token is bound to a specific organization, or when the integration has access to exactly one organization.

Required string length: 32

Pattern: ^org_[A-Za-z0-9]+$

Example:

"org_EkzhrUc3U6C0UbxNBlK7WLz51ofT"

Idempotency-Key

string

Only applies to POST, PUT, PATCH, and DELETE; ignored on reads.

Type: IdempotencyKey A unique key that makes a mutating request safely retryable, kept for 24 hours

Path Parameters

ent_id

string

required

ID of the entity

Required string length: 32

Pattern: ^ent_[A-Za-z0-9]+$

Example:

"ent_H0hdMOc5E5QMTEcGVZKegvLNCB6p"

Body

application/json

Required array length: 1 - 100 elements

string

required

ID of the contact

Required string length: 32

Pattern: ^cnt_[A-Za-z0-9]+$

Example:

"cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI"

Response

Contacts associated with the entity

Type: List A page of results

object

enum<string>

required

Object type identifier.

Available options:

list

Example:

"list"

data

object[]

required

The page of items.

Show child attributes

next_page_url

string | null

required

URL for the next page of the list, or null when there are no more pages.

Example:

"/v1/contacts?page=page_5dr8SFDbv7rZ2aj4&limit=10"

previous_page_url

string | null

required

URL for the previous page of the list, or null when there are none.

Example:

"/v1/contacts?page_before=page_8VtqLBv3xJpY7mk2&limit=10"

has_more

boolean

required

deprecated

Whether there are more items available after this page. Deprecated: next_page_url is non-null exactly when more pages exist.

url

string

required

deprecated

Path identifying this list. Deprecated: on lists embedded in another object, or returned by a create, it may not be a GET endpoint you can call. Follow next_page_url / previous_page_url to paginate.

Example:

"/v1/contacts"

Distributions

Payment Instructions

Entities

Contacts

Organizations

Vehicles

Financial Accounts

Associate contacts with an entity

Authorizations

Headers

Path Parameters

Body

Response