List contacts
curl --request GET \
--url https://app.nudgen.net/api/v1/contacts \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.nudgen.net/api/v1/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.nudgen.net/api/v1/contacts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"contacts": [
{
"id": "<string>",
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"description": "<string>",
"status": "active",
"tags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"page": 123,
"limit": 123,
"totalPages": 123
}{
"error": "<string>"
}{
"error": "<string>"
}API reference
List contacts
Lists contacts in the active workspace. Contact PII is decrypted in the authorized response.
GET
/
api
/
v1
/
contacts
List contacts
curl --request GET \
--url https://app.nudgen.net/api/v1/contacts \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.nudgen.net/api/v1/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.nudgen.net/api/v1/contacts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"contacts": [
{
"id": "<string>",
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"description": "<string>",
"status": "active",
"tags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"page": 123,
"limit": 123,
"totalPages": 123
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Personal Access Token created from Settings -> API Keys.
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100Search by decrypted contact email.
Comma-separated tags.
Comma-separated statuses.
Example:
"active,unsubscribed"
Was this page helpful?