Excluded Contacts

Get all excluded contacts with pagination and search

Excluded contacts are people your agents must never import again. A contact is excluded when it is deleted (from the platform or with DELETE /v1/contact/): its LinkedIn profile URL, LinkedIn member ID and email, when known, are kept in your excluded contacts. The Lead sources agents skip any lead matching one of them, and POST /v1/contact refuses to create it again (CONTACT_ALREADY_EXCLUDED). Use this route to find the exclusions of a person, then DELETE /v1/excluded-contact/ each of them to allow the person to be imported again. A person can be covered by several exclusions (for example one holding their profile URL and another their email), and stays blocked while any of them remains: pass every identifier you know (identifier, profileId, email) to find them all. When several filters are provided, an exclusion matching any of them is returned. Results are sorted from the most recent exclusion to the oldest.

GET

https://ext.gojiberry.ai

excluded-contact

curl --request GET \
  --url https://ext.gojiberry.ai/v1/excluded-contact \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ext.gojiberry.ai/v1/excluded-contact', 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://ext.gojiberry.ai/v1/excluded-contact",
  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://ext.gojiberry.ai/v1/excluded-contact"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://ext.gojiberry.ai/v1/excluded-contact")

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

{
  "excludedContacts": [
    {
      "id": 123,
      "profileUrl": "<string>",
      "linkedinMemberId": 123,
      "email": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "totalPages": 123
}

Authorizations

Authorization

string

header

required

Enter API Key

Headers

x-impersonate-user-id

string

ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.

Query Parameters

page

number

Page number (starts from 1)

limit

number

Number of excluded contacts per page (default: 20, maximum: 100)

identifier

string

LinkedIn public identifier of the person (eg. johndoe), or their full LinkedIn profile URL (eg. https://www.linkedin.com/in/johndoe). Matches exclusions with this LinkedIn profile URL.

profileId

string

LinkedIn profile ID of the person (eg. ACoAABcwGZ0BPKyEbC2o13Qq7MhrAaD), or a profile URN containing it. Matches exclusions with the LinkedIn member ID behind this profile ID.

string

Email address of the person. Matches exclusions with exactly this email.

Response

List of excluded contacts with pagination information

excludedContacts

object[]

Show child attributes

total

number

Total number of excluded contacts matching the search

page

number

Current page number

limit

number

Number of excluded contacts per page

totalPages

number

Total number of pages

Get all excluded contacts with pagination and search

curl --request GET \
  --url https://ext.gojiberry.ai/v1/excluded-contact \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ext.gojiberry.ai/v1/excluded-contact', 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://ext.gojiberry.ai/v1/excluded-contact",
  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://ext.gojiberry.ai/v1/excluded-contact"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://ext.gojiberry.ai/v1/excluded-contact")

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

{
  "excludedContacts": [
    {
      "id": 123,
      "profileUrl": "<string>",
      "linkedinMemberId": 123,
      "email": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "totalPages": 123
}

Getting Started

API reference

Get all excluded contacts with pagination and search

Authorizations

Headers

Query Parameters

Response