Get a campaign - Mintlify Starter Kit

GET

https://ext.gojiberry.ai

/

v1

/

campaign

/

{id}

Get one campaign

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

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

fetch('https://ext.gojiberry.ai/v1/campaign/{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/campaign/{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/campaign/{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/campaign/{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>",
  "userId": 123,
  "active": true,
  "excludeFirstDegreeFromCampaigns": true,
  "splitLinkedinMessagesIntoConversation": false,
  "isManual": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "steps": [
    {}
  ],
  "skipInvitationAfterDays": 123,
  "language": "<string>",
  "tone": "professional",
  "goal": "conversations",
  "linkedinSeatId": 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

id

number

required

Response

200 - application/json

Get one campaign

id

number

required

Unique identifier for the campaign

name

string

required

Name of the campaign

userId

number

required

User ID who owns this campaign

active

boolean

default:true

required

Whether the campaign is active

excludeFirstDegreeFromCampaigns

boolean

default:true

required

Exclude first degree connections from campaigns

splitLinkedinMessagesIntoConversation

boolean

default:false

required

When enabled, LinkedIn message steps may be sent as multiple shorter messages when it feels natural

isManual

boolean

default:false

required

Whether the campaign is manual

createdAt

string<date-time>

required

Creation timestamp

updatedAt

string<date-time>

required

Last update timestamp

steps

object[]

Campaign steps

skipInvitationAfterDays

number

Number of days after which a pending invitation is skipped and only email steps are sent

language

string | null

Campaign language

tone

enum<string>

Campaign tone

Available options:

professional,

direct,

conversational

goal

enum<string>

Campaign goal

Available options:

conversations,

demos

linkedinSeatId

number

LinkedIn seat ID for this campaign

⌘I

Get one campaign

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

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

fetch('https://ext.gojiberry.ai/v1/campaign/{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/campaign/{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/campaign/{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/campaign/{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>",
  "userId": 123,
  "active": true,
  "excludeFirstDegreeFromCampaigns": true,
  "splitLinkedinMessagesIntoConversation": false,
  "isManual": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "steps": [
    {}
  ],
  "skipInvitationAfterDays": 123,
  "language": "<string>",
  "tone": "professional",
  "goal": "conversations",
  "linkedinSeatId": 123
}