List contacts
curl --request GET \
--url https://api.routera.io/contacts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.routera.io/contacts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.routera.io/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.routera.io/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.routera.io/contacts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.routera.io/contacts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.routera.io/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"external_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"contact_owner": "jane@example.com",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"archived": true,
"archived_by": "<string>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"count": 123
}
}{
"message": "<string>",
"error": true,
"field": "<string>"
}{
"message": "<string>",
"error": true,
"field": "<string>"
}{
"message": "<string>",
"error": true,
"field": "<string>"
}Contacts
List contacts
GET /contacts — paginated list with optional property filter
GET
/
contacts
List contacts
curl --request GET \
--url https://api.routera.io/contacts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.routera.io/contacts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.routera.io/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.routera.io/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.routera.io/contacts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.routera.io/contacts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.routera.io/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"external_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"contact_owner": "jane@example.com",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"archived": true,
"archived_by": "<string>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"count": 123
}
}{
"message": "<string>",
"error": true,
"field": "<string>"
}{
"message": "<string>",
"error": true,
"field": "<string>"
}{
"message": "<string>",
"error": true,
"field": "<string>"
}Endpoint
GET https://api.routera.io/contacts
/contactsAuthentication: Bearer JWT
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
properties | string | (defaults below) | Comma-separated list of additional property names to include alongside the default set for this object type (e.g. ?properties=phone). Names already in the default set are not duplicated. Invalid or disallowed property names return 400. |
archived | boolean | false | Set to true to include archived objects |
limit | integer | 10 | Maximum number of results (10–100) |
offset | integer | 0 | Pagination offset |
Default response fields
Whenproperties is omitted, each item in data includes:
| Property | Description |
|---|---|
id | Internal object ID |
first_name | Custom or system field (flat on the object) |
last_name | Custom or system field (flat on the object) |
email | Custom or system field (flat on the object) |
contact_owner | Assigned owner email |
external_id | External identifier (nullable) |
archived | false when active; ISO timestamp when archived |
created_at and updated_at are always included in every response (ISO 8601 UTC), even when not listed above. When an object is archived, archived_by is also included automatically.Response
200 — Paginated list{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"external_id": "ext-001",
"created_at": "2026-05-01T10:00:00.000Z",
"updated_at": "2026-05-28T12:00:00.000Z",
"archived": false,
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"contact_owner": "jane@example.com"
}
],
"pagination": {
"limit": 10,
"offset": 0,
"count": 1
}
}
Errors
| Status | When |
|---|---|
400 | Invalid properties query (empty list or invalid property name) |
401 | Missing or invalid account context in JWT |
500 | Internal server error |
{ "message": "Invalid property name: example", "error": true }
Authorizations
Bearer JWT with valid account context.
Query Parameters
Comma-separated additional property names to include alongside defaults (e.g. phone). Invalid or disallowed names return 400.
Include archived objects when true
Maximum results (default 10, max 100)
Required range:
1 <= x <= 100Pagination offset (default 0)
Required range:
x >= 0Response
Paginated list
Hide child attributes
Hide child attributes
Assigned owner email
Example:
"jane@example.com"
false when active, or ISO timestamp when archived
Present when archived
Was this page helpful?
⌘I
