List campaigns
curl --request GET \
--url https://my.jobin.cloud/api/openapi/v1/campaigns \
--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', 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"
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' -Method GET -Headers $headers{
"items": [
{
"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"
}
],
"page": 123,
"limit": 123,
"total": 123
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}Campaigns
List Campaigns
Browse Jobin campaigns, which correspond to sequences in the UI, with paging and active-state filters.
GET
/
campaigns
List campaigns
curl --request GET \
--url https://my.jobin.cloud/api/openapi/v1/campaigns \
--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', 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"
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' -Method GET -Headers $headers{
"items": [
{
"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"
}
],
"page": 123,
"limit": 123,
"total": 123
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}Use this endpoint when your integration needs to discover or verify a sequence before assignment.
Authorizations
Primary public authentication method. Create keys in Jobin.cloud under Workgroups > Integrations > Custom integration.
Query Parameters
One-based result page. Page-number pagination is capped at 100.
Required range:
1 <= x <= 100Required range:
1 <= x <= 25When true, include the matching campaign count. The default is false to avoid unnecessary count work.
