Get a source agent

GET

https://ext.gojiberry.ai

agent

{id}

Get one source agent

curl --request GET \
  --url https://ext.gojiberry.ai/v1/agent/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://ext.gojiberry.ai/v1/agent/{id}', 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/agent/{id}",
  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/agent/{id}"

	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/agent/{id}")

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

{
  "id": 123,
  "name": "<string>",
  "targetJobTitles": [
    "<string>"
  ],
  "targetIndustries": [
    "<string>"
  ],
  "targetCompanySizes": [
    "<string>"
  ],
  "targetLocations": [
    "<string>"
  ],
  "targetCompanyTypes": [
    "<string>"
  ],
  "agentType": "autopilot",
  "scriptInstalled": false,
  "currentCreditUsage": 0,
  "paused": false,
  "excludeServiceProviders": false,
  "skipIcpFilter": false,
  "includeOpenToWorkProfiles": false,
  "leadWaterfall": true,
  "userId": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "additionalCriteria": "<string>",
  "variables": [
    "<string>"
  ],
  "ignoredCompanies": [
    "<string>"
  ],
  "mandatoryKeywords": [
    "<string>"
  ],
  "trackingScriptId": "<string>",
  "maxCreditUsage": 200,
  "lastRun": "2023-11-07T05:31:56Z",
  "minLeadScore": 0.75,
  "listId": 123
}

Authorizations

Authorization

string

header

required

API key from Settings → API. Send it as Authorization: Bearer .

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.

Path Parameters

number

required

Response

Agent found

number

required

Unique identifier

name

string

required

Display name of the agent

targetJobTitles

string[]

required

List of target job titles to prospect. Part of the ICP.

targetIndustries

string[]

required

List of target industries to prospect. Part of the ICP.

targetCompanySizes

string[]

required

List of target company sizes (e.g. "1-10", "11-50"). Part of the ICP.

targetLocations

string[]

required

List of target geographic locations. Part of the ICP.

targetCompanyTypes

string[]

required

List of target company types (e.g. "Public", "Private")

agentType

string

required

Type of agent: "autopilot", "lookalike" or "website-visitor"

Example:

"autopilot"

scriptInstalled

boolean

default:false

required

Whether the visitor tracking script is installed on the website (website-visitor agents)

currentCreditUsage

number

default:0

required

Credits consumed so far in the current period (e.g. website-visitor company identifications)

paused

boolean

default:false

required

Whether the agent is paused and will not run on its next scheduled time

excludeServiceProviders

boolean

default:false

required

Whether to exclude service provider companies from prospecting

skipIcpFilter

boolean

default:false

required

Whether to skip the ICP (Ideal Customer Profile) filter when sourcing leads

includeOpenToWorkProfiles

boolean

default:false

required

Whether to include LinkedIn profiles marked as open to work

leadWaterfall

boolean

default:true

required

Whether to use the lead waterfall strategy (cascade through multiple sources)

userId

number

required

ID of the account (user) who owns this agent

createdAt

string<date-time>

required

Creation timestamp

updatedAt

string<date-time>

required

Last update timestamp

additionalCriteria

string | null

Additional free-text targeting criteria

variables

string[] | null

Variables used by the agent to find high intent leads. (Keywords, Competitor Page URL, etc.)

ignoredCompanies

string[] | null

Company names to exclude from prospecting. Part of the ICP.

mandatoryKeywords

string[] | null

Keywords that must be present in a lead profile to be included

trackingScriptId

string | null

Snitcher tracking script ID, used as the profileId in the tracking snippet (website-visitor agents)

maxCreditUsage

number | null

Max number of credits per month

Example:

200

lastRun

string<date-time> | null

Timestamp of the last agent execution

minLeadScore

number | null

Minimum lead score threshold (0.00–1.00) required to include a lead

Example:

0.75

listId

number | null

ID of the list this agent sources contacts into

⌘I

Get one source agent

curl --request GET \
  --url https://ext.gojiberry.ai/v1/agent/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://ext.gojiberry.ai/v1/agent/{id}', 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/agent/{id}",
  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/agent/{id}"

	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/agent/{id}")

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

{
  "id": 123,
  "name": "<string>",
  "targetJobTitles": [
    "<string>"
  ],
  "targetIndustries": [
    "<string>"
  ],
  "targetCompanySizes": [
    "<string>"
  ],
  "targetLocations": [
    "<string>"
  ],
  "targetCompanyTypes": [
    "<string>"
  ],
  "agentType": "autopilot",
  "scriptInstalled": false,
  "currentCreditUsage": 0,
  "paused": false,
  "excludeServiceProviders": false,
  "skipIcpFilter": false,
  "includeOpenToWorkProfiles": false,
  "leadWaterfall": true,
  "userId": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "additionalCriteria": "<string>",
  "variables": [
    "<string>"
  ],
  "ignoredCompanies": [
    "<string>"
  ],
  "mandatoryKeywords": [
    "<string>"
  ],
  "trackingScriptId": "<string>",
  "maxCreditUsage": 200,
  "lastRun": "2023-11-07T05:31:56Z",
  "minLeadScore": 0.75,
  "listId": 123
}

Getting Started

API reference

Authorizations

Headers

Path Parameters

Response