Get campaign
curl --request GET \
--url https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)$headers=@{}
$headers.Add("x-api-key", "<api-key>")
$response = Invoke-WebRequest -Uri 'https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}' -Method GET -Headers $headers{
"id": "<string>",
"name": "<string>",
"isActive": true,
"goal": "<string>",
"dripCampaignArchived": true,
"senderGroups": [
"<unknown>"
],
"dripStageCount": 123,
"contactCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"dripStages": [
"<unknown>"
],
"operationsTimeframe": {},
"sequenceAnalysis": {}
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}Campaigns
Get Campaign
Fetch one Jobin campaign and inspect its stages, timing configuration, and sequence analysis data.
GET
/
campaigns
/
{campaignId}
Get campaign
curl --request GET \
--url https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)$headers=@{}
$headers.Add("x-api-key", "<api-key>")
$response = Invoke-WebRequest -Uri 'https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}' -Method GET -Headers $headers{
"id": "<string>",
"name": "<string>",
"isActive": true,
"goal": "<string>",
"dripCampaignArchived": true,
"senderGroups": [
"<unknown>"
],
"dripStageCount": 123,
"contactCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"dripStages": [
"<unknown>"
],
"operationsTimeframe": {},
"sequenceAnalysis": {}
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}This page is useful when you need to confirm the target sequence before adding contacts.
Authorizations
Primary public authentication method. Create keys in Jobin.cloud under Workgroups > Integrations > Custom integration.
Path Parameters
Response
Campaign detail
Public sequence summary. The backend uses campaign ids for the same entities the UI labels as sequences.
