List contacts
curl --request GET \
--url https://core-service.prod.brudcast.com/api/v1/user/contacts \
--header 'X-API-Key: <api-key>'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/contacts"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://core-service.prod.brudcast.com/api/v1/user/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://core-service.prod.brudcast.com/api/v1/user/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 => [
"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://core-service.prod.brudcast.com/api/v1/user/contacts"
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))
}HttpResponse<String> response = Unirest.get("https://core-service.prod.brudcast.com/api/v1/user/contacts")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/contacts")
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{
"success": true,
"message": "<string>",
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"timezone": "Africa/Lagos",
"language": "en",
"status": "active",
"customFields": {},
"notes": "<string>",
"lastActivityAt": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"emails": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"status": "verified",
"isPrimary": true,
"bounceCount": 123,
"complaintCount": 123,
"verifiedAt": "2023-11-07T05:31:56Z",
"lastBouncedAt": "2023-11-07T05:31:56Z",
"lastComplainedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"smsNumbers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "+2348012345678",
"countryCode": "NG",
"status": "verified",
"isPrimary": true,
"verifiedAt": "2023-11-07T05:31:56Z",
"optedOutAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"whatsappAccounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "+2348012345678",
"countryCode": "NG",
"status": "verified",
"isPrimary": true,
"isBusinessAccount": true,
"lastSeenAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"telegramAccounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "+2348012345678",
"countryCode": "NG",
"username": "<string>",
"status": "active",
"isPrimary": true,
"lastActiveAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"imessageAccounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appleId": "jsmith@example.com",
"phoneNumber": "+2348012345678",
"status": "verified",
"isPrimary": true,
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"pushNotifications": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deviceToken": "<string>",
"platform": "ios",
"status": "active",
"appVersion": "3.4.1",
"deviceInfo": {},
"isPrimary": true,
"lastUsedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"tagRecords": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "newsletter",
"contactCount": 42,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"listMemberships": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactListId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "subscribed",
"subscribedAt": "2023-11-07T05:31:56Z",
"unsubscribedAt": "2023-11-07T05:31:56Z",
"unsubscribeReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"status": "active",
"tags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"emails": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"status": "verified",
"isPrimary": true,
"bounceCount": 123,
"complaintCount": 123,
"verifiedAt": "2023-11-07T05:31:56Z",
"lastBouncedAt": "2023-11-07T05:31:56Z",
"lastComplainedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"contactList": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cuid": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Product announcements",
"description": "<string>",
"status": "active",
"preferredChannels": [
"email"
],
"tags": [
"<string>"
],
"isDefault": true,
"subscriberCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
]
}
],
"meta": {
"total": 137,
"perPage": 20,
"currentPage": 1,
"lastPage": 7,
"firstPage": 1,
"firstPageUrl": "/?page=1",
"lastPageUrl": "/?page=7",
"nextPageUrl": "/?page=2",
"previousPageUrl": null
}
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "The payload is invalid",
"code": "E_VALIDATION_ERROR",
"errors": [
{
"field": "emailAddress",
"rule": "email",
"message": "The emailAddress field must be a valid email address"
}
]
}{
"success": false,
"message": "Too many requests",
"code": "E_TOO_MANY_REQUESTS",
"retryAfter": 60
}Contacts
List contacts
Returns the organization’s contacts with their channel records and tags preloaded. Beyond the page figures, meta carries filters, the descriptors that describe every filter this endpoint accepts along with the values available for each, and appliedFilters, the normalised echo of the query that was run. Requires the contacts:read scope.
GET
/
api
/
v1
/
user
/
contacts
List contacts
curl --request GET \
--url https://core-service.prod.brudcast.com/api/v1/user/contacts \
--header 'X-API-Key: <api-key>'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/contacts"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://core-service.prod.brudcast.com/api/v1/user/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://core-service.prod.brudcast.com/api/v1/user/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 => [
"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://core-service.prod.brudcast.com/api/v1/user/contacts"
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))
}HttpResponse<String> response = Unirest.get("https://core-service.prod.brudcast.com/api/v1/user/contacts")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/contacts")
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{
"success": true,
"message": "<string>",
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"timezone": "Africa/Lagos",
"language": "en",
"status": "active",
"customFields": {},
"notes": "<string>",
"lastActivityAt": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"emails": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"status": "verified",
"isPrimary": true,
"bounceCount": 123,
"complaintCount": 123,
"verifiedAt": "2023-11-07T05:31:56Z",
"lastBouncedAt": "2023-11-07T05:31:56Z",
"lastComplainedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"smsNumbers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "+2348012345678",
"countryCode": "NG",
"status": "verified",
"isPrimary": true,
"verifiedAt": "2023-11-07T05:31:56Z",
"optedOutAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"whatsappAccounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "+2348012345678",
"countryCode": "NG",
"status": "verified",
"isPrimary": true,
"isBusinessAccount": true,
"lastSeenAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"telegramAccounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "+2348012345678",
"countryCode": "NG",
"username": "<string>",
"status": "active",
"isPrimary": true,
"lastActiveAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"imessageAccounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appleId": "jsmith@example.com",
"phoneNumber": "+2348012345678",
"status": "verified",
"isPrimary": true,
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"pushNotifications": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deviceToken": "<string>",
"platform": "ios",
"status": "active",
"appVersion": "3.4.1",
"deviceInfo": {},
"isPrimary": true,
"lastUsedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"tagRecords": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "newsletter",
"contactCount": 42,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"listMemberships": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactListId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "subscribed",
"subscribedAt": "2023-11-07T05:31:56Z",
"unsubscribedAt": "2023-11-07T05:31:56Z",
"unsubscribeReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"status": "active",
"tags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"emails": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"status": "verified",
"isPrimary": true,
"bounceCount": 123,
"complaintCount": 123,
"verifiedAt": "2023-11-07T05:31:56Z",
"lastBouncedAt": "2023-11-07T05:31:56Z",
"lastComplainedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"contactList": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cuid": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Product announcements",
"description": "<string>",
"status": "active",
"preferredChannels": [
"email"
],
"tags": [
"<string>"
],
"isDefault": true,
"subscriberCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
]
}
],
"meta": {
"total": 137,
"perPage": 20,
"currentPage": 1,
"lastPage": 7,
"firstPage": 1,
"firstPageUrl": "/?page=1",
"lastPageUrl": "/?page=7",
"nextPageUrl": "/?page=2",
"previousPageUrl": null
}
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "The payload is invalid",
"code": "E_VALIDATION_ERROR",
"errors": [
{
"field": "emailAddress",
"rule": "email",
"message": "The emailAddress field must be a valid email address"
}
]
}{
"success": false,
"message": "Too many requests",
"code": "E_TOO_MANY_REQUESTS",
"retryAfter": 60
}Authorizations
apiKeyapiKeyBearer
An organization API key, prefixed bk_live_. Takes precedence over Authorization when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint.
Headers
Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403.
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100Minimum string length:
1Available options:
active, inactive, archived Available options:
email, sms, whatsapp, telegram, imessage, push Available options:
firstName, lastName, createdAt, updatedAt, lastActivityAt Available options:
asc, desc