Skip to main content
API docs by Redocly

Platform API (v5)

Download OpenAPI specification:Download

The Talroo Platform API provides programmatic management of many of the objects that are available in the Talroo Ad Platform (TAP). This API allows our TAP customers the ability to customize their experience a little bit by building their own applications that pull in only the data that they're interested in seeing or integrating TAP data with their existing applications. While TAP has many more features, the Platform API exposes lower-level flexibility to manage objects when you want and how you want.

App Clients

Get AppClients

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=name,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=name,desc&sort=clientId,asc)

Supported fields (different for each endpoint)
name, clientId, createdAt, customerId
Nested fields
customer.id, customer.createdAt, customer.name, customer.modifiedAt

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Create an AppClient

Authorizations:
bearer
Request Body schema: application/json
required
name
string

App Client name

accessTokenExpirySeconds
integer <int32>

How long App Client generated tokens are valid before expiring

scopes
Array of strings

App Client scopes

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "accessTokenExpirySeconds": 0,
  • "scopes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "accessTokenExpirySeconds": 300,
  • "createdAt": "1970-01-01T00:00Z",
  • "scopes": [
    ],
  • "secret": "string"
}

Get an AppClient by ID

Authorizations:
bearer
path Parameters
id
required
string

App Client ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "accessTokenExpirySeconds": 300,
  • "createdAt": "1970-01-01T00:00Z",
  • "scopes": [
    ],
  • "secret": "string"
}

Delete an AppClient by ID

Authorizations:
bearer
path Parameters
id
required
string

App Client ID

Responses

Get scopes available to an AppClient

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of any

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Application Questions

Validate that Application Questions are in the Talroo format

Authorizations:
bearer
Request Body schema: application/json
required
Array
any

Responses

Request samples

Content type
application/json
[
  • null
]

Response samples

Content type
application/json
{
  • "valid": true
}

Click Volume Estimate

Recommend the CPC based on the volume

Authorizations:
bearer
Request Body schema: application/json
required
title
required
string

Job title

company
required
string

Company name

zipcodes
required
Array of strings

A list of zipcodes. Each zipcode is a string.

description
string

Job description

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "company": "string",
  • "zipcodes": [
    ],
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "cpc": 0.1,
  • "cpa": 0.1
}

Recommend the CPC based on the budget

Authorizations:
bearer
Request Body schema: application/json
required
title
required
string

Job title

company
required
string

Company name

zipcodes
required
Array of strings

A list of zipcodes. Each zipcode is a string.

budget
required
number <float>

Monthly budget

description
string

Job description

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "company": "string",
  • "zipcodes": [
    ],
  • "budget": 0.1,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "cpc": 0.1
}

Predict the number of applications and the number of clicks for jobs

Authorizations:
bearer
Request Body schema: application/json
required
Array ([ 1 .. 200 ] items)
title
required
string

Job title

company
required
string

Company name

price
required
number <float>

Either a CPC or target CPA, in cents

priceType
required
string
Enum: "cpc" "target_cpa"

The type for price attribute. The value is either cpc or target_cpa.

zipcodes
required
Array of strings

A list of zipcodes. Each zipcode is a string.

description
string

Job description

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Companies

Get my Companies

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=name,asc)

Supported fields (different for each endpoint)
id, name

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, name

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get a Company by ID

Authorizations:
bearer
path Parameters
companyId
required
integer <int32>

Talroo Company ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "customLogoUrl": "string",
  • "logoExpire": "2019-08-24T14:15:22Z"
}

Dispositions

Get all Disposition Types

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of any

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

search
any

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Enum - Categories

Get Categories

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=indication,asc)

Supported fields (different for each endpoint)
id, indication, description

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, indication, description

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get a Category by ID

Authorizations:
bearer
path Parameters
categoryId
required
integer <int32>

Job Category ID. See Classification API

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "description": "string",
  • "indication": "MAJOR_INDUSTRY"
}

Enum - Pause Reasons

Get Pause Reasons

Authorizations:
bearer
query Parameters
search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id

page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=id,asc)

Supported fields (different for each endpoint)
id

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get a Pause Reason by ID

Authorizations:
bearer
path Parameters
pauseReasonId
required
integer <int32>

Pause Reason ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string"
}

Job Applications

Get Applications by Segment ID

Authorizations:
bearer
path Parameters
segmentId
required
integer <int32>
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=tlrApplicationId,asc)

Supported fields (different for each endpoint)
id, tlrApplicationId, applicationTime, completed, createdAt, tlrSid, qualified, redirectUrl, campaignId, segmentId
Nested fields
job.jobId, job.sourceId, job.jobReference, job.originalJobReference, job.company, job.title, job.zipcode, job.city, job.state, job.url, applicant.firstName, applicant.lastName, applicant.phone, applicant.emailAddress, applicant.address, applicant.city, applicant.state, applicant.zipcode, applicant.country, applicant.userAgent, campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, tlrApplicationId, applicationTime, completed, createdAt, tlrSid, qualified, redirectUrl, campaignId, segmentId
Nested fields
job.jobId, job.sourceId, job.jobReference, job.originalJobReference, job.company, job.title, job.zipcode, job.city, job.state, job.url, applicant.firstName, applicant.lastName, applicant.phone, applicant.emailAddress, applicant.address, applicant.city, applicant.state, applicant.zipcode, applicant.country, applicant.userAgent, campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

expand
Array of strings unique
Default: ""
Items Enum: "qualifyingQuestionAnswers" "resume"

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get Applications

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=tlrApplicationId,asc)

Supported fields (different for each endpoint)
id, tlrApplicationId, applicationTime, completed, createdAt, tlrSid, qualified, redirectUrl, campaignId, segmentId
Nested fields
job.jobId, job.sourceId, job.jobReference, job.originalJobReference, job.company, job.title, job.zipcode, job.city, job.state, job.url, applicant.firstName, applicant.lastName, applicant.phone, applicant.emailAddress, applicant.address, applicant.city, applicant.state, applicant.zipcode, applicant.country, applicant.userAgent, campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, tlrApplicationId, applicationTime, completed, createdAt, tlrSid, qualified, redirectUrl, campaignId, segmentId
Nested fields
job.jobId, job.sourceId, job.jobReference, job.originalJobReference, job.company, job.title, job.zipcode, job.city, job.state, job.url, applicant.firstName, applicant.lastName, applicant.phone, applicant.emailAddress, applicant.address, applicant.city, applicant.state, applicant.zipcode, applicant.country, applicant.userAgent, campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

expand
Array of strings unique
Default: ""
Items Enum: "qualifyingQuestionAnswers" "resume"

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get Applications by Campaign ID

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=tlrApplicationId,asc)

Supported fields (different for each endpoint)
id, tlrApplicationId, applicationTime, completed, createdAt, tlrSid, qualified, redirectUrl, campaignId, segmentId
Nested fields
job.jobId, job.sourceId, job.jobReference, job.originalJobReference, job.company, job.title, job.zipcode, job.city, job.state, job.url, applicant.firstName, applicant.lastName, applicant.phone, applicant.emailAddress, applicant.address, applicant.city, applicant.state, applicant.zipcode, applicant.country, applicant.userAgent, campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, tlrApplicationId, applicationTime, completed, createdAt, tlrSid, qualified, redirectUrl, campaignId, segmentId
Nested fields
job.jobId, job.sourceId, job.jobReference, job.originalJobReference, job.company, job.title, job.zipcode, job.city, job.state, job.url, applicant.firstName, applicant.lastName, applicant.phone, applicant.emailAddress, applicant.address, applicant.city, applicant.state, applicant.zipcode, applicant.country, applicant.userAgent, campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

expand
Array of strings unique
Default: ""
Items Enum: "qualifyingQuestionAnswers" "resume"

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get an Application by ID

Authorizations:
bearer
path Parameters
applicationId
required
integer <int32>
query Parameters
expand
Array of strings unique
Default: ""
Items Enum: "qualifyingQuestionAnswers" "resume"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "tlrApplicationId": "string",
  • "job": {
    },
  • "applicant": {
    },
  • "resume": {
    },
  • "applicationTime": "1970-01-01T00:00Z",
  • "completed": true,
  • "createdAt": "1970-01-01T00:00Z",
  • "tlrSid": "string",
  • "questionsAndAnswers": [
    ],
  • "qualified": true,
  • "qualifyingQuestionAnswers": [
    ],
  • "redirectUrl": "string",
  • "campaignId": 0,
  • "segmentId": 0
}

downloadResume

Authorizations:
bearer
path Parameters
applicationId
required
integer <int32>

Job Application ID

Responses

Job Campaigns

Get JobCampaigns by JobPool

Authorizations:
bearer
path Parameters
poolId
required
integer <int32>

Job Pool ID

query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=modifiedAt,asc)

Supported fields (different for each endpoint)
id, modifiedAt, status, mtdSpend, createdAt, name, applyOrder, adType, poolId
Nested fields
pool.id, pool.createdAt, pool.name, pool.isCpa, pool.modifiedAt, pool.customer.id, pool.customer.createdAt, pool.customer.name, pool.customer.modifiedAt, pool.customerId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, modifiedAt, status, mtdSpend, createdAt, name, applyOrder, adType, poolId
Nested fields
pool.id, pool.createdAt, pool.name, pool.isCpa, pool.modifiedAt, pool.customer.id, pool.customer.createdAt, pool.customer.name, pool.customer.modifiedAt, pool.customerId

report
Array of strings
Items Enum: "EVENTS" "JOBS" "POOL" "SCHEDULING" "SPENDING" "SURVEY_STATUS"
expand
Array of strings unique
Default: ""
Items Enum: "events" "jobs" "scheduling" "spending" "surveyStatus"

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Create a JobCampaign

Authorizations:
bearer
path Parameters
poolId
required
integer <int32>

Job Pool ID

Request Body schema: application/json
required
name
required
string

Job Campaign name

basicCpc
integer <int32>

CPC used by Talroo Apply and Talroo Basic campaigns

monthlyBudget
required
number

The monthly recurring budget for the campaign

jobBudgetType
required
string
Enum: "MONTHLY" "NONE"

Enable and set job level budget type

jobBudgetDefault
required
number

Default job level budget

applyOrder
integer <int32>

Order (descending) in which campaigns have their job filters applied to remaining jobs within the pool

object (ConfigQuery)

Filter jobs into this campaign based on various job object fields

targetCpa
integer <int32>

Goal CPA used by campaigns utilizing the Target CPA bidding strategy

talrooApply
boolean

Boolean indicating whether this is a Talroo Apply campaign

emailAddress
string

Email address to which Talroo Apply applicants and Talroo Event RSVP reports will be sent, when applicable

otherEmailAddresses
required
Array of strings

Additional email addresses to receive Talroo Apply New Applicant and Event RSVP emails, when applicable

talrooApplySkipResume
required
boolean

Talroo Apply Only: [Optional] Boolean indicating whether applicants will be prompted to submit a resume as part of the Talroo Apply application

talrooApplyReqResume
required
boolean

Talroo Apply Only: [Optional] Boolean indicating whether a resume is required as part of the Talroo Apply application

talrooApplySendUnqualified
required
boolean

Talroo Apply Only: [Optional] Boolean indicating whether we forward data for unqualified Talroo Apply applications

talrooApplyRedir
required
boolean

Talroo Apply Only: [Optional] Feature to automatically redirect applicants to the job's URL after applying

budgetPacing
required
boolean

Whether this campaign is utilizing the automatic budget pacing mechanism

extendBudgetPacing
required
boolean

Whether this campaign continues to use budget pacing after the pacingDom

pacingDom
required
integer <int8>

When using budget pacing, apply pacing to the campaign's budget until this day of the month

minCpc
required
integer <int32>

Minimum cost per click for this Job Campaign

talrooProCpc
integer <int32>

CPC used by Talroo Pro campaigns

talrooPro
string
Enum: "OFF" "ON"

Boolean indicating whether this is a Talroo Pro campaign

adType
required
string
Enum: "EVENT" "JOB"

Campaign Ad Type that denotes whether this is a Standard Job Campaign or a Hiring Event campaign

eventStartDt
string <date>

Hiring Events Only: [Required] Event start date

eventEndDt
string <date>

Hiring Events Only: [Required] Event end date

eventLocation
string

Hiring Events Only: [Required] Physical address, or URL if online, where event will take place

eventType
string
Enum: "IN_PERSON" "ONLINE"

Hiring Events Only: [Required] Whether this is an in-person or online event

eventTimes
string

Hiring Events Only: [Required] Formatted times of the event

eventTimeslot
required
integer <int8>

Hiring Events Only: [Optional] Length of timeslots in minutes (30 or 60 are supported). When set, this will require users to RSVP to specific timeslots

eventTimeslotLimit
integer <int32>

Hiring Events Only: [Optional] Limits the amount of RSVPs that can be made for a single timeslot

eventCustomTy
string

Hiring Events Only: [Optional] Custom thank you message to show users after they RSVP

eventPrepare
string

Hiring Events Only: [Optional] Verbiage around how users should prepare for the event after they RSVP

eventWear
string

Hiring Events Only: [Optional] Verbiage around what users should wear to the event

fullTargetCpa
required
boolean

Boolean indicating whether this campaign is allowed to bid up on high converting traffic. HIGHLY RECOMMENDED TO BE SET TO TRUE

targetCpaType
string
Enum: "CAMPAIGN" "CAMPAIGN_FIXED" "JOB" "JOB_FIXED" "NONE"

Target CPA Only: Field to indicate what type of Target CPA campaign this is

autopilot
boolean

Boolean indicating whether this campaign is utilizing our Autopilot bidding strategy

autopilotMaxCpc
integer <int32>

Maximum CPC that can be set when using our Autopilot bidding strategy

required
object

Additional Field object to be used with integrations. Please reach out to your Talroo POC for options

talrooFeaturedType
required
string
Enum: "AI_ALWAYS_ON" "ALWAYS_ON" "ALWAYS_ON_ABSOLUTE" "CPC_BASED" "J2C_ALWAYS_ON" "J2C_CPC_BASED" "OFF"

Enum indicating if this campaign is a Talroo Featured campaign

talrooApplyPro
required
boolean

Boolean indicating if this campaign is a Talroo Apply Pro campaign

sendReminders
required
string
Enum: "OFF" "ON"

Boolean indicating whether this campaign sends reminders for unfinished applications

reminderType
required
string
Enum: "BOTH" "EMAIL" "NONE" "SMS"

Enum indicating how this campaign sends reminders for unfinished applications

applicationLinkOverride
string

The job application link override for a campaign

addressQuestion
required
string
Enum: "OFF" "OPTIONAL" "REQUIRED"

Whether we add an address question to the Talroo Apply application form

workExperienceQuestions
required
string
Enum: "OFF" "OPTIONAL" "OPTIONAL_IF_NO_RESUME" "REQUIRED" "REQUIRE_IF_NO_RESUME"

Whether we add work experience questions to the Talroo Apply application form

educationHistoryQuestions
required
string
Enum: "OFF" "OPTIONAL" "OPTIONAL_IF_NO_RESUME" "REQUIRED" "REQUIRE_IF_NO_RESUME"

Whether we add education history questions to the Talroo Apply application form

enableAutoArchive
required
boolean

Whether this campaign is eligible for auto archival

autoArchiveAt
string <date-time>

The timestamp at which the campaign should be automatically archived

useSmartCpc
boolean

Flag indicating usage of recommended cpc api to set the bid on jobs filtered into this campaign

candidateTier
string
Enum: "ET" "FT" "ST"

The minimum tier of candidate targeting for this campaign

object

Candidate tier settings with multiplier and source parameter for each tier

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "basicCpc": 0,
  • "monthlyBudget": 0,
  • "jobBudgetType": "MONTHLY",
  • "jobBudgetDefault": 0,
  • "applyOrder": 0,
  • "jobFilters": {
    },
  • "targetCpa": 0,
  • "talrooApply": true,
  • "emailAddress": "string",
  • "otherEmailAddresses": [
    ],
  • "talrooApplySkipResume": true,
  • "talrooApplyReqResume": true,
  • "talrooApplySendUnqualified": true,
  • "talrooApplyRedir": true,
  • "budgetPacing": true,
  • "extendBudgetPacing": true,
  • "pacingDom": 0,
  • "minCpc": 0,
  • "talrooProCpc": 0,
  • "talrooPro": "OFF",
  • "adType": "EVENT",
  • "eventStartDt": "1970-01-01",
  • "eventEndDt": "1970-01-01",
  • "eventLocation": "string",
  • "eventType": "IN_PERSON",
  • "eventTimes": "string",
  • "eventTimeslot": 0,
  • "eventTimeslotLimit": 0,
  • "eventCustomTy": "string",
  • "eventPrepare": "string",
  • "eventWear": "string",
  • "fullTargetCpa": true,
  • "targetCpaType": "CAMPAIGN",
  • "autopilot": true,
  • "autopilotMaxCpc": 0,
  • "additionalFields": {
    },
  • "talrooFeaturedType": "AI_ALWAYS_ON",
  • "talrooApplyPro": true,
  • "sendReminders": "OFF",
  • "reminderType": "BOTH",
  • "applicationLinkOverride": "string",
  • "addressQuestion": "OFF",
  • "workExperienceQuestions": "OFF",
  • "educationHistoryQuestions": "OFF",
  • "enableAutoArchive": true,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "useSmartCpc": true,
  • "candidateTier": "ET",
  • "candidateTierSettings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "poolId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "adType": "EVENT",
  • "additionalFields": {
    },
  • "addressQuestion": "OFF",
  • "applicationLinkOverride": "string",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilot": true,
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "budgetPacing": true,
  • "campaignQuestions": [
    ],
  • "candidateTier": "ET",
  • "candidateTierSettings": {
    },
  • "createdAt": "1970-01-01T00:00Z",
  • "dailyCapResetTime": "00:00Z",
  • "dailyCapped": true,
  • "dailyCappedTime": "1970-01-01T00:00Z",
  • "educationHistoryQuestions": "OFF",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "eventCustomTy": "string",
  • "eventEndDt": "1970-01-01",
  • "eventLocation": "string",
  • "eventPrepare": "string",
  • "eventStartDt": "1970-01-01",
  • "eventTimes": "string",
  • "eventTimeslot": 0,
  • "eventTimeslotLimit": 1,
  • "eventType": "IN_PERSON",
  • "eventWear": "string",
  • "events": {
    },
  • "extendBudgetPacing": true,
  • "fullTargetCpa": true,
  • "jobBudgetDefault": 0,
  • "jobBudgetType": "MONTHLY",
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "oneTimeBudgetDollars": 0,
  • "otherEmailAddresses": [
    ],
  • "pacingDom": 0,
  • "pauseReason": {
    },
  • "pauseReasonId": 0,
  • "pool": {
    },
  • "reminderType": "BOTH",
  • "report": {
    },
  • "scheduling": {
    },
  • "sendReminders": "OFF",
  • "spending": {
    },
  • "surveyStatus": {
    },
  • "talrooApply": true,
  • "talrooApplyPro": true,
  • "talrooApplyRedir": true,
  • "talrooApplyReqResume": true,
  • "talrooApplySendUnqualified": true,
  • "talrooApplySkipResume": true,
  • "talrooFeaturedType": "AI_ALWAYS_ON",
  • "talrooPro": "OFF",
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "targetCpaType": "CAMPAIGN",
  • "totalBudgetDollars": 0,
  • "useSmartCpc": true,
  • "workExperienceQuestions": "OFF"
}

Set a JobCampaign to Paused

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>

Talroo Job Campaign ID

query Parameters
reasonId
integer <int32>

[Optional] Pause Reason ID. See Enum - Pause Reasons

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "poolId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "adType": "EVENT",
  • "additionalFields": {
    },
  • "addressQuestion": "OFF",
  • "applicationLinkOverride": "string",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilot": true,
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "budgetPacing": true,
  • "campaignQuestions": [
    ],
  • "candidateTier": "ET",
  • "candidateTierSettings": {
    },
  • "createdAt": "1970-01-01T00:00Z",
  • "dailyCapResetTime": "00:00Z",
  • "dailyCapped": true,
  • "dailyCappedTime": "1970-01-01T00:00Z",
  • "educationHistoryQuestions": "OFF",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "eventCustomTy": "string",
  • "eventEndDt": "1970-01-01",
  • "eventLocation": "string",
  • "eventPrepare": "string",
  • "eventStartDt": "1970-01-01",
  • "eventTimes": "string",
  • "eventTimeslot": 0,
  • "eventTimeslotLimit": 1,
  • "eventType": "IN_PERSON",
  • "eventWear": "string",
  • "events": {
    },
  • "extendBudgetPacing": true,
  • "fullTargetCpa": true,
  • "jobBudgetDefault": 0,
  • "jobBudgetType": "MONTHLY",
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "oneTimeBudgetDollars": 0,
  • "otherEmailAddresses": [
    ],
  • "pacingDom": 0,
  • "pauseReason": {
    },
  • "pauseReasonId": 0,
  • "pool": {
    },
  • "reminderType": "BOTH",
  • "report": {
    },
  • "scheduling": {
    },
  • "sendReminders": "OFF",
  • "spending": {
    },
  • "surveyStatus": {
    },
  • "talrooApply": true,
  • "talrooApplyPro": true,
  • "talrooApplyRedir": true,
  • "talrooApplyReqResume": true,
  • "talrooApplySendUnqualified": true,
  • "talrooApplySkipResume": true,
  • "talrooFeaturedType": "AI_ALWAYS_ON",
  • "talrooPro": "OFF",
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "targetCpaType": "CAMPAIGN",
  • "totalBudgetDollars": 0,
  • "useSmartCpc": true,
  • "workExperienceQuestions": "OFF"
}

Set a JobCampaign to Live

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>

Talroo Job Campaign ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "poolId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "adType": "EVENT",
  • "additionalFields": {
    },
  • "addressQuestion": "OFF",
  • "applicationLinkOverride": "string",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilot": true,
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "budgetPacing": true,
  • "campaignQuestions": [
    ],
  • "candidateTier": "ET",
  • "candidateTierSettings": {
    },
  • "createdAt": "1970-01-01T00:00Z",
  • "dailyCapResetTime": "00:00Z",
  • "dailyCapped": true,
  • "dailyCappedTime": "1970-01-01T00:00Z",
  • "educationHistoryQuestions": "OFF",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "eventCustomTy": "string",
  • "eventEndDt": "1970-01-01",
  • "eventLocation": "string",
  • "eventPrepare": "string",
  • "eventStartDt": "1970-01-01",
  • "eventTimes": "string",
  • "eventTimeslot": 0,
  • "eventTimeslotLimit": 1,
  • "eventType": "IN_PERSON",
  • "eventWear": "string",
  • "events": {
    },
  • "extendBudgetPacing": true,
  • "fullTargetCpa": true,
  • "jobBudgetDefault": 0,
  • "jobBudgetType": "MONTHLY",
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "oneTimeBudgetDollars": 0,
  • "otherEmailAddresses": [
    ],
  • "pacingDom": 0,
  • "pauseReason": {
    },
  • "pauseReasonId": 0,
  • "pool": {
    },
  • "reminderType": "BOTH",
  • "report": {
    },
  • "scheduling": {
    },
  • "sendReminders": "OFF",
  • "spending": {
    },
  • "surveyStatus": {
    },
  • "talrooApply": true,
  • "talrooApplyPro": true,
  • "talrooApplyRedir": true,
  • "talrooApplyReqResume": true,
  • "talrooApplySendUnqualified": true,
  • "talrooApplySkipResume": true,
  • "talrooFeaturedType": "AI_ALWAYS_ON",
  • "talrooPro": "OFF",
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "targetCpaType": "CAMPAIGN",
  • "totalBudgetDollars": 0,
  • "useSmartCpc": true,
  • "workExperienceQuestions": "OFF"
}

Create a new JobCampaign from an existing JobCampaign

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>

Talroo Job Campaign ID

Request Body schema: application/json
required
name
required
string

New name for the Job Campaign copy

poolId
required
integer <int32>

Job Pool ID to put the new Job Campaign copy under

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "poolId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "poolId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "adType": "EVENT",
  • "additionalFields": {
    },
  • "addressQuestion": "OFF",
  • "applicationLinkOverride": "string",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilot": true,
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "budgetPacing": true,
  • "campaignQuestions": [
    ],
  • "candidateTier": "ET",
  • "candidateTierSettings": {
    },
  • "createdAt": "1970-01-01T00:00Z",
  • "dailyCapResetTime": "00:00Z",
  • "dailyCapped": true,
  • "dailyCappedTime": "1970-01-01T00:00Z",
  • "educationHistoryQuestions": "OFF",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "eventCustomTy": "string",
  • "eventEndDt": "1970-01-01",
  • "eventLocation": "string",
  • "eventPrepare": "string",
  • "eventStartDt": "1970-01-01",
  • "eventTimes": "string",
  • "eventTimeslot": 0,
  • "eventTimeslotLimit": 1,
  • "eventType": "IN_PERSON",
  • "eventWear": "string",
  • "events": {
    },
  • "extendBudgetPacing": true,
  • "fullTargetCpa": true,
  • "jobBudgetDefault": 0,
  • "jobBudgetType": "MONTHLY",
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "oneTimeBudgetDollars": 0,
  • "otherEmailAddresses": [
    ],
  • "pacingDom": 0,
  • "pauseReason": {
    },
  • "pauseReasonId": 0,
  • "pool": {
    },
  • "reminderType": "BOTH",
  • "report": {
    },
  • "scheduling": {
    },
  • "sendReminders": "OFF",
  • "spending": {
    },
  • "surveyStatus": {
    },
  • "talrooApply": true,
  • "talrooApplyPro": true,
  • "talrooApplyRedir": true,
  • "talrooApplyReqResume": true,
  • "talrooApplySendUnqualified": true,
  • "talrooApplySkipResume": true,
  • "talrooFeaturedType": "AI_ALWAYS_ON",
  • "talrooPro": "OFF",
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "targetCpaType": "CAMPAIGN",
  • "totalBudgetDollars": 0,
  • "useSmartCpc": true,
  • "workExperienceQuestions": "OFF"
}

Archive a JobCampaign

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>

Talroo Job Campaign ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "poolId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "adType": "EVENT",
  • "additionalFields": {
    },
  • "addressQuestion": "OFF",
  • "applicationLinkOverride": "string",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilot": true,
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "budgetPacing": true,
  • "campaignQuestions": [
    ],
  • "candidateTier": "ET",
  • "candidateTierSettings": {
    },
  • "createdAt": "1970-01-01T00:00Z",
  • "dailyCapResetTime": "00:00Z",
  • "dailyCapped": true,
  • "dailyCappedTime": "1970-01-01T00:00Z",
  • "educationHistoryQuestions": "OFF",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "eventCustomTy": "string",
  • "eventEndDt": "1970-01-01",
  • "eventLocation": "string",
  • "eventPrepare": "string",
  • "eventStartDt": "1970-01-01",
  • "eventTimes": "string",
  • "eventTimeslot": 0,
  • "eventTimeslotLimit": 1,
  • "eventType": "IN_PERSON",
  • "eventWear": "string",
  • "events": {
    },
  • "extendBudgetPacing": true,
  • "fullTargetCpa": true,
  • "jobBudgetDefault": 0,
  • "jobBudgetType": "MONTHLY",
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "oneTimeBudgetDollars": 0,
  • "otherEmailAddresses": [
    ],
  • "pacingDom": 0,
  • "pauseReason": {
    },
  • "pauseReasonId": 0,
  • "pool": {
    },
  • "reminderType": "BOTH",
  • "report": {
    },
  • "scheduling": {
    },
  • "sendReminders": "OFF",
  • "spending": {
    },
  • "surveyStatus": {
    },
  • "talrooApply": true,
  • "talrooApplyPro": true,
  • "talrooApplyRedir": true,
  • "talrooApplyReqResume": true,
  • "talrooApplySendUnqualified": true,
  • "talrooApplySkipResume": true,
  • "talrooFeaturedType": "AI_ALWAYS_ON",
  • "talrooPro": "OFF",
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "targetCpaType": "CAMPAIGN",
  • "totalBudgetDollars": 0,
  • "useSmartCpc": true,
  • "workExperienceQuestions": "OFF"
}

Get a JobCampaign by ID

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>

Talroo Job Campaign ID

query Parameters
report
Array of strings
Items Enum: "EVENTS" "JOBS" "POOL" "SCHEDULING" "SPENDING" "SURVEY_STATUS"
expand
Array of strings unique
Default: ""
Items Enum: "events" "jobs" "scheduling" "spending" "surveyStatus"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "poolId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "adType": "EVENT",
  • "additionalFields": {
    },
  • "addressQuestion": "OFF",
  • "applicationLinkOverride": "string",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilot": true,
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "budgetPacing": true,
  • "campaignQuestions": [
    ],
  • "candidateTier": "ET",
  • "candidateTierSettings": {
    },
  • "createdAt": "1970-01-01T00:00Z",
  • "dailyCapResetTime": "00:00Z",
  • "dailyCapped": true,
  • "dailyCappedTime": "1970-01-01T00:00Z",
  • "educationHistoryQuestions": "OFF",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "eventCustomTy": "string",
  • "eventEndDt": "1970-01-01",
  • "eventLocation": "string",
  • "eventPrepare": "string",
  • "eventStartDt": "1970-01-01",
  • "eventTimes": "string",
  • "eventTimeslot": 0,
  • "eventTimeslotLimit": 1,
  • "eventType": "IN_PERSON",
  • "eventWear": "string",
  • "events": {
    },
  • "extendBudgetPacing": true,
  • "fullTargetCpa": true,
  • "jobBudgetDefault": 0,
  • "jobBudgetType": "MONTHLY",
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "oneTimeBudgetDollars": 0,
  • "otherEmailAddresses": [
    ],
  • "pacingDom": 0,
  • "pauseReason": {
    },
  • "pauseReasonId": 0,
  • "pool": {
    },
  • "reminderType": "BOTH",
  • "report": {
    },
  • "scheduling": {
    },
  • "sendReminders": "OFF",
  • "spending": {
    },
  • "surveyStatus": {
    },
  • "talrooApply": true,
  • "talrooApplyPro": true,
  • "talrooApplyRedir": true,
  • "talrooApplyReqResume": true,
  • "talrooApplySendUnqualified": true,
  • "talrooApplySkipResume": true,
  • "talrooFeaturedType": "AI_ALWAYS_ON",
  • "talrooPro": "OFF",
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "targetCpaType": "CAMPAIGN",
  • "totalBudgetDollars": 0,
  • "useSmartCpc": true,
  • "workExperienceQuestions": "OFF"
}

Update a JobCampaign

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>

Talroo Job Campaign ID

Request Body schema: application/json
required
name
string

Job Campaign name

basicCpc
integer <int32>

CPC used by Talroo Apply and Talroo Basic campaigns

monthlyBudget
number

The monthly recurring budget for the campaign

jobBudgetType
string
Enum: "MONTHLY" "NONE"

Enable and set job level budget type

jobBudgetDefault
number

Default job level budget

applyOrder
integer <int32>

Order (descending) in which campaigns have their job filters applied to remaining jobs within the pool

object (ConfigQuery)

Filter jobs into this campaign based on various job object fields

targetCpa
integer <int32>

Goal CPA used by campaigns utilizing the Target CPA bidding strategy

talrooApply
boolean

Boolean indicating whether this is a Talroo Apply campaign

emailAddress
string

Email address to which Talroo Apply applicants and Talroo Event RSVP reports will be sent, when applicable

otherEmailAddresses
Array of strings

Additional email addresses to receive Talroo Apply New Applicant and Event RSVP emails, when applicable

talrooApplySkipResume
boolean

Talroo Apply Only: [Optional] Boolean indicating whether applicants will be prompted to submit a resume as part of the Talroo Apply application

talrooApplyReqResume
boolean

Talroo Apply Only: [Optional] Boolean indicating whether a resume is required as part of the Talroo Apply application

talrooApplySendUnqualified
boolean

Talroo Apply Only: [Optional] Boolean indicating whether we forward data for unqualified Talroo Apply applications

talrooApplyRedir
boolean

Talroo Apply Only: [Optional] Feature to automatically redirect applicants to the job's URL after applying

budgetPacing
boolean

Whether this campaign is utilizing the automatic budget pacing mechanism

extendBudgetPacing
boolean

Whether this campaign continues to use budget pacing after the pacingDom

pacingDom
integer <int8>

When using budget pacing, apply pacing to the campaign's budget until this day of the month

minCpc
integer <int32>

Minimum cost per click for this Job Campaign

talrooProCpc
integer <int32>

CPC used by Talroo Pro campaigns

talrooPro
string
Enum: "OFF" "ON"

Boolean indicating whether this is a Talroo Pro campaign

eventStartDt
string <date>

Hiring Events Only: [Required] Event start date

eventEndDt
string <date>

Hiring Events Only: [Required] Event end date

eventLocation
string

Hiring Events Only: [Required] Physical address, or URL if online, where event will take place

eventType
string
Enum: "IN_PERSON" "ONLINE"

Hiring Events Only: [Required] Whether this is an in-person or online event

eventTimes
string

Hiring Events Only: [Required] Formatted times of the event

eventTimeslot
integer <int8>

Hiring Events Only: [Optional] Length of timeslots in minutes (30 or 60 are supported). When set, this will require users to RSVP to specific timeslots

eventTimeslotLimit
integer <int32>

Hiring Events Only: [Optional] Limits the amount of RSVPs that can be made for a single timeslot

eventCustomTy
string

Hiring Events Only: [Optional] Custom thank you message to show users after they RSVP

eventPrepare
string

Hiring Events Only: [Optional] Verbiage around how users should prepare for the event after they RSVP

eventWear
string

Hiring Events Only: [Optional] Verbiage around what users should wear to the event

fullTargetCpa
boolean

Boolean indicating whether this campaign is allowed to bid up on high converting traffic. HIGHLY RECOMMENDED TO BE SET TO TRUE

targetCpaType
string
Enum: "CAMPAIGN" "CAMPAIGN_FIXED" "JOB" "JOB_FIXED" "NONE"

Target CPA Only: Field to indicate what type of Target CPA campaign this is

autopilot
boolean

Boolean indicating whether this campaign is utilizing our Autopilot bidding strategy

autopilotMaxCpc
integer <int32>

Maximum CPC that can be set when using our Autopilot bidding strategy

object

Additional Field object to be used with integrations. Please reach out to your Talroo POC for options

talrooFeaturedType
string
Enum: "AI_ALWAYS_ON" "ALWAYS_ON" "ALWAYS_ON_ABSOLUTE" "CPC_BASED" "J2C_ALWAYS_ON" "J2C_CPC_BASED" "OFF"

Enum indicating if this campaign is a Talroo Featured campaign

talrooApplyPro
boolean

Boolean indicating if this campaign is a Talroo Apply Pro campaign

sendReminders
string
Enum: "OFF" "ON"

Boolean indicating whether this campaign sends reminders for unfinished applications

reminderType
string
Enum: "BOTH" "EMAIL" "NONE" "SMS"

Enum indicating how this campaign sends reminders for unfinished applications

applicationLinkOverride
string

The job application link override for a campaign

addressQuestion
string
Enum: "OFF" "OPTIONAL" "REQUIRED"

Whether we add an address question to the Talroo Apply application form

workExperienceQuestions
string
Enum: "OFF" "OPTIONAL" "OPTIONAL_IF_NO_RESUME" "REQUIRED" "REQUIRE_IF_NO_RESUME"

Whether we add work experience questions to the Talroo Apply application form

educationHistoryQuestions
string
Enum: "OFF" "OPTIONAL" "OPTIONAL_IF_NO_RESUME" "REQUIRED" "REQUIRE_IF_NO_RESUME"

Whether we add education history questions to the Talroo Apply application form

enableAutoArchive
boolean

Whether this campaign is eligible for auto archival

autoArchiveAt
string <date-time>

The timestamp at which the campaign should be automatically archived

useSmartCpc
boolean

Flag indicating usage of recommended cpc api to set the bid on jobs filtered into this campaign

candidateTier
string
Enum: "ET" "FT" "ST"

The minimum tier of candidate targeting for this campaign

object

Candidate tier settings with multiplier and source parameter for each tier

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "basicCpc": 0,
  • "monthlyBudget": 0,
  • "jobBudgetType": "MONTHLY",
  • "jobBudgetDefault": 0,
  • "applyOrder": 0,
  • "jobFilters": {
    },
  • "targetCpa": 0,
  • "talrooApply": true,
  • "emailAddress": "string",
  • "otherEmailAddresses": [
    ],
  • "talrooApplySkipResume": true,
  • "talrooApplyReqResume": true,
  • "talrooApplySendUnqualified": true,
  • "talrooApplyRedir": true,
  • "budgetPacing": true,
  • "extendBudgetPacing": true,
  • "pacingDom": 0,
  • "minCpc": 0,
  • "talrooProCpc": 0,
  • "talrooPro": "OFF",
  • "eventStartDt": "1970-01-01",
  • "eventEndDt": "1970-01-01",
  • "eventLocation": "string",
  • "eventType": "IN_PERSON",
  • "eventTimes": "string",
  • "eventTimeslot": 0,
  • "eventTimeslotLimit": 0,
  • "eventCustomTy": "string",
  • "eventPrepare": "string",
  • "eventWear": "string",
  • "fullTargetCpa": true,
  • "targetCpaType": "CAMPAIGN",
  • "autopilot": true,
  • "autopilotMaxCpc": 0,
  • "additionalFields": {
    },
  • "talrooFeaturedType": "AI_ALWAYS_ON",
  • "talrooApplyPro": true,
  • "sendReminders": "OFF",
  • "reminderType": "BOTH",
  • "applicationLinkOverride": "string",
  • "addressQuestion": "OFF",
  • "workExperienceQuestions": "OFF",
  • "educationHistoryQuestions": "OFF",
  • "enableAutoArchive": true,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "useSmartCpc": true,
  • "candidateTier": "ET",
  • "candidateTierSettings": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "poolId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "adType": "EVENT",
  • "additionalFields": {
    },
  • "addressQuestion": "OFF",
  • "applicationLinkOverride": "string",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilot": true,
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "budgetPacing": true,
  • "campaignQuestions": [
    ],
  • "candidateTier": "ET",
  • "candidateTierSettings": {
    },
  • "createdAt": "1970-01-01T00:00Z",
  • "dailyCapResetTime": "00:00Z",
  • "dailyCapped": true,
  • "dailyCappedTime": "1970-01-01T00:00Z",
  • "educationHistoryQuestions": "OFF",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "eventCustomTy": "string",
  • "eventEndDt": "1970-01-01",
  • "eventLocation": "string",
  • "eventPrepare": "string",
  • "eventStartDt": "1970-01-01",
  • "eventTimes": "string",
  • "eventTimeslot": 0,
  • "eventTimeslotLimit": 1,
  • "eventType": "IN_PERSON",
  • "eventWear": "string",
  • "events": {
    },
  • "extendBudgetPacing": true,
  • "fullTargetCpa": true,
  • "jobBudgetDefault": 0,
  • "jobBudgetType": "MONTHLY",
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "oneTimeBudgetDollars": 0,
  • "otherEmailAddresses": [
    ],
  • "pacingDom": 0,
  • "pauseReason": {
    },
  • "pauseReasonId": 0,
  • "pool": {
    },
  • "reminderType": "BOTH",
  • "report": {
    },
  • "scheduling": {
    },
  • "sendReminders": "OFF",
  • "spending": {
    },
  • "surveyStatus": {
    },
  • "talrooApply": true,
  • "talrooApplyPro": true,
  • "talrooApplyRedir": true,
  • "talrooApplyReqResume": true,
  • "talrooApplySendUnqualified": true,
  • "talrooApplySkipResume": true,
  • "talrooFeaturedType": "AI_ALWAYS_ON",
  • "talrooPro": "OFF",
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "targetCpaType": "CAMPAIGN",
  • "totalBudgetDollars": 0,
  • "useSmartCpc": true,
  • "workExperienceQuestions": "OFF"
}

Get my JobCampaigns

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=modifiedAt,asc)

Supported fields (different for each endpoint)
id, modifiedAt, status, mtdSpend, createdAt, name, applyOrder, adType, poolId
Nested fields
pool.id, pool.createdAt, pool.name, pool.isCpa, pool.modifiedAt, pool.customer.id, pool.customer.createdAt, pool.customer.name, pool.customer.modifiedAt, pool.customerId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, modifiedAt, status, mtdSpend, createdAt, name, applyOrder, adType, poolId
Nested fields
pool.id, pool.createdAt, pool.name, pool.isCpa, pool.modifiedAt, pool.customer.id, pool.customer.createdAt, pool.customer.name, pool.customer.modifiedAt, pool.customerId

report
Array of strings
Items Enum: "EVENTS" "JOBS" "POOL" "SCHEDULING" "SPENDING" "SURVEY_STATUS"
expand
Array of strings unique
Default: ""
Items Enum: "events" "jobs" "scheduling" "spending" "surveyStatus"
subCustomerId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Job Customers

Get my Customer

Authorizations:
bearer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "ccEmailAddress": "string",
  • "createdAt": "1970-01-01T00:00Z",
  • "emailAddress": "string",
  • "features": {
    },
  • "jobApplicationQuestionsEnabled": true,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "sigmaEmbedUrl": "string",
  • "sigmaPreSignedEmbedUrl": "string",
  • "test": true
}

Job Expansions

Get Job Expansions by Job Reference

Authorizations:
bearer
path Parameters
sourceId
required
integer <int32>
jobReference
required
string
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=title,asc)

Supported fields (different for each endpoint)
id, title, createdAt, modifiedAt, lastImported, sourceId
Nested fields
source.id, source.status, source.name, source.createdAt, source.modifiedAt, source.pool.id, source.pool.createdAt, source.pool.name, source.pool.isCpa, source.pool.modifiedAt, source.pool.customer.id, source.pool.customer.createdAt, source.pool.customer.name, source.pool.customer.modifiedAt, source.pool.customerId, source.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, title, createdAt, modifiedAt, lastImported, sourceId
Nested fields
source.id, source.status, source.name, source.createdAt, source.modifiedAt, source.pool.id, source.pool.createdAt, source.pool.name, source.pool.isCpa, source.pool.modifiedAt, source.pool.customer.id, source.pool.customer.createdAt, source.pool.customer.name, source.pool.customer.modifiedAt, source.pool.customerId, source.poolId

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Create a Job Expansion Deprecated

Authorizations:
bearer
path Parameters
sourceId
required
integer <int32>
jobReference
required
string
Request Body schema: application/json
required
title
required
string

Job title for this Job Expansion

object (JobExpansionFilter)

JobExpansionFilter object containing a list of job references and job titles upon which to match jobs for expansion

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "jobFilters": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "sourceId": 0,
  • "title": "string",
  • "createdAt": "1970-01-01T00:00Z",
  • "modifiedAt": "1970-01-01T00:00Z",
  • "lastImported": "1970-01-01T00:00Z",
  • "jobFilters": {
    }
}

Get Job Expansions by Source ID

Authorizations:
bearer
path Parameters
sourceId
required
integer <int32>
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=title,asc)

Supported fields (different for each endpoint)
id, title, createdAt, modifiedAt, lastImported, sourceId
Nested fields
source.id, source.status, source.name, source.createdAt, source.modifiedAt, source.pool.id, source.pool.createdAt, source.pool.name, source.pool.isCpa, source.pool.modifiedAt, source.pool.customer.id, source.pool.customer.createdAt, source.pool.customer.name, source.pool.customer.modifiedAt, source.pool.customerId, source.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, title, createdAt, modifiedAt, lastImported, sourceId
Nested fields
source.id, source.status, source.name, source.createdAt, source.modifiedAt, source.pool.id, source.pool.createdAt, source.pool.name, source.pool.isCpa, source.pool.modifiedAt, source.pool.customer.id, source.pool.customer.createdAt, source.pool.customer.name, source.pool.customer.modifiedAt, source.pool.customerId, source.poolId

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Create a Job Expansion

Authorizations:
bearer
path Parameters
sourceId
required
integer <int32>
Request Body schema: application/json
required
title
required
string

Job title for this Job Expansion

object (JobExpansionFilter)

JobExpansionFilter object containing a list of job references and job titles upon which to match jobs for expansion

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "jobFilters": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "sourceId": 0,
  • "title": "string",
  • "createdAt": "1970-01-01T00:00Z",
  • "modifiedAt": "1970-01-01T00:00Z",
  • "lastImported": "1970-01-01T00:00Z",
  • "jobFilters": {
    }
}

Get Job Expansions by Job ID

Authorizations:
bearer
path Parameters
jobId
required
string
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=title,asc)

Supported fields (different for each endpoint)
id, title, createdAt, modifiedAt, lastImported, sourceId
Nested fields
source.id, source.status, source.name, source.createdAt, source.modifiedAt, source.pool.id, source.pool.createdAt, source.pool.name, source.pool.isCpa, source.pool.modifiedAt, source.pool.customer.id, source.pool.customer.createdAt, source.pool.customer.name, source.pool.customer.modifiedAt, source.pool.customerId, source.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, title, createdAt, modifiedAt, lastImported, sourceId
Nested fields
source.id, source.status, source.name, source.createdAt, source.modifiedAt, source.pool.id, source.pool.createdAt, source.pool.name, source.pool.isCpa, source.pool.modifiedAt, source.pool.customer.id, source.pool.customer.createdAt, source.pool.customer.name, source.pool.customer.modifiedAt, source.pool.customerId, source.poolId

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Create a Job Expansion Deprecated

Authorizations:
bearer
path Parameters
jobId
required
string
Request Body schema: application/json
required
title
required
string

Job title for this Job Expansion

object (JobExpansionFilter)

JobExpansionFilter object containing a list of job references and job titles upon which to match jobs for expansion

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "jobFilters": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "sourceId": 0,
  • "title": "string",
  • "createdAt": "1970-01-01T00:00Z",
  • "modifiedAt": "1970-01-01T00:00Z",
  • "lastImported": "1970-01-01T00:00Z",
  • "jobFilters": {
    }
}

Create Job Expansions in bulk

Authorizations:
bearer
Request Body schema: application/json
required
Array of objects (JobExpansionBulkCreate)
Array
sourceId
required
integer <int32>

Job Source ID

title
required
string

Job title for this Job Expansion

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get a Job Expansion by ID

Authorizations:
bearer
path Parameters
expansionId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "sourceId": 0,
  • "title": "string",
  • "createdAt": "1970-01-01T00:00Z",
  • "modifiedAt": "1970-01-01T00:00Z",
  • "lastImported": "1970-01-01T00:00Z",
  • "jobFilters": {
    }
}

Delete a Job Expansion

Authorizations:
bearer
path Parameters
expansionId
required
integer <int32>

Responses

Update a Job Expansion

Authorizations:
bearer
path Parameters
expansionId
required
integer <int32>
Request Body schema: application/json
required
title
string

Job title for this Job Expansion

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "sourceId": 0,
  • "title": "string",
  • "createdAt": "1970-01-01T00:00Z",
  • "modifiedAt": "1970-01-01T00:00Z",
  • "lastImported": "1970-01-01T00:00Z",
  • "jobFilters": {
    }
}

Get all Job Expansions

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=title,asc)

Supported fields (different for each endpoint)
id, title, createdAt, modifiedAt, lastImported, sourceId
Nested fields
source.id, source.status, source.name, source.createdAt, source.modifiedAt, source.pool.id, source.pool.createdAt, source.pool.name, source.pool.isCpa, source.pool.modifiedAt, source.pool.customer.id, source.pool.customer.createdAt, source.pool.customer.name, source.pool.customer.modifiedAt, source.pool.customerId, source.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, title, createdAt, modifiedAt, lastImported, sourceId
Nested fields
source.id, source.status, source.name, source.createdAt, source.modifiedAt, source.pool.id, source.pool.createdAt, source.pool.name, source.pool.isCpa, source.pool.modifiedAt, source.pool.customer.id, source.pool.customer.createdAt, source.pool.customer.name, source.pool.customer.modifiedAt, source.pool.customerId, source.poolId

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Job Pools

Get a JobPool by ID

Authorizations:
bearer
path Parameters
poolId
required
integer <int32>

Job Pool ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "subCustomerId": 0,
  • "name": "string",
  • "additionalFields": {
    },
  • "callToAction": {
    },
  • "callToActionId": 0,
  • "cpaBitmap": { },
  • "createdAt": "1970-01-01T00:00Z",
  • "enableTlrSid": true,
  • "isCpa": true,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "requiredQualifyingQuestionSetIds": [
    ],
  • "requiredQualifyingQuestionSets": [
    ],
  • "thirdPartyIntegration": {
    },
  • "thirdPartyIntegrationType": "ADECCO_INTEGRATION"
}

Get my JobPools

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=createdAt,asc)

Supported fields (different for each endpoint)
id, createdAt, name, isCpa, modifiedAt, customerId
Nested fields
customer.id, customer.createdAt, customer.name, customer.modifiedAt

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, createdAt, name, isCpa, modifiedAt, customerId
Nested fields
customer.id, customer.createdAt, customer.name, customer.modifiedAt

subCustomerId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Job Segments

Set a JobSegment to Paused

Authorizations:
bearer
path Parameters
segmentId
required
integer <int32>

Talroo Job Segment ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "createdAt": "1970-01-01T00:00Z",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "events": {
    },
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "pool": {
    },
  • "report": {
    },
  • "scheduling": {
    },
  • "spending": {
    },
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "useSmartCpc": true
}

Set a JobSegment to Live

Authorizations:
bearer
path Parameters
segmentId
required
integer <int32>

Talroo Job Segment ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "createdAt": "1970-01-01T00:00Z",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "events": {
    },
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "pool": {
    },
  • "report": {
    },
  • "scheduling": {
    },
  • "spending": {
    },
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "useSmartCpc": true
}

Create a new JobSegment from an existing JobSegment

Authorizations:
bearer
path Parameters
segmentId
required
integer <int32>

Talroo Job Segment ID

Request Body schema: application/json
required
name
required
string

New name for the Job Segment copy

campaignId
required
integer <int32>

Job Campaign ID to put the new Job Segment copy under

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "campaignId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "createdAt": "1970-01-01T00:00Z",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "events": {
    },
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "pool": {
    },
  • "report": {
    },
  • "scheduling": {
    },
  • "spending": {
    },
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "useSmartCpc": true
}

Archive a JobSegment

Authorizations:
bearer
path Parameters
segmentId
required
integer <int32>

Talroo Job Segment ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "createdAt": "1970-01-01T00:00Z",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "events": {
    },
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "pool": {
    },
  • "report": {
    },
  • "scheduling": {
    },
  • "spending": {
    },
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "useSmartCpc": true
}

Get a JobCampaign's JobSegments

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=name,asc)

Supported fields (different for each endpoint)
id, name, status, applyOrder, mtdSpend, createdAt, modifiedAt, campaignId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, name, status, applyOrder, mtdSpend, createdAt, modifiedAt, campaignId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

report
Array of strings
Items Enum: "EVENTS" "JOBS" "POOL" "SCHEDULING" "SPENDING"
expand
Array of strings unique
Default: ""
Items Enum: "events" "jobs" "scheduling" "spending"
subCustomerId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Create a JobSegment

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>
Request Body schema: application/json
required
name
string

Job Segment name

basicCpc
integer <int32>

CPC used for segments within non-Talroo Pro campaigns

monthlyBudget
number

Job Segment monthly budget

applyOrder
integer <int32>

Order in which this Job Segment's job filters will be applied to remaining pool jobs

object (ConfigQuery)

Filter jobs into this Job Segment based on various job object fields

targetCpa
integer <int32>

Goal CPA used by segments utilizing the Target CPA bidding strategy

emailAddress
string

Email address to which new Talroo Apply applicant emails will be sent

minCpc
integer <int32>

Minimum cost per click

talrooProCpc
integer <int32>

CPC used for Job Segments within Talroo Pro campaigns

enableAutoArchive
boolean

Whether this segment is eligible for auto archival

autoArchiveAt
string <date-time>

The timestamp at which the segment should be automatically archived

useSmartCpc
boolean

Flag indicating usage of recommended cpc api to set the bid on jobs filtered into this segment

autopilotMaxCpc
integer <int32>

Maximum CPC that can be set when using our Autopilot bidding strategy (overrides campaign-level value)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "basicCpc": 0,
  • "monthlyBudget": 0,
  • "applyOrder": 0,
  • "jobFilters": {
    },
  • "targetCpa": 0,
  • "emailAddress": "string",
  • "minCpc": 0,
  • "talrooProCpc": 0,
  • "enableAutoArchive": true,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "useSmartCpc": true,
  • "autopilotMaxCpc": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "createdAt": "1970-01-01T00:00Z",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "events": {
    },
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "pool": {
    },
  • "report": {
    },
  • "scheduling": {
    },
  • "spending": {
    },
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "useSmartCpc": true
}

Get a JobSegment by ID

Authorizations:
bearer
path Parameters
segmentId
required
integer <int32>

Talroo Job Segment ID

query Parameters
report
Array of strings
Items Enum: "EVENTS" "JOBS" "POOL" "SCHEDULING" "SPENDING"
expand
Array of strings unique
Default: ""
Items Enum: "events" "jobs" "scheduling" "spending"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "createdAt": "1970-01-01T00:00Z",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "events": {
    },
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "pool": {
    },
  • "report": {
    },
  • "scheduling": {
    },
  • "spending": {
    },
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "useSmartCpc": true
}

Update a JobSegment

Authorizations:
bearer
path Parameters
segmentId
required
integer <int32>

Talroo Job Segment ID

Request Body schema: application/json
required
name
string

Job Segment name

basicCpc
integer <int32>

CPC used for segments within non-Talroo Pro campaigns

monthlyBudget
number

Job Segment monthly budget

applyOrder
integer <int32>

Order in which this Job Segment's job filters will be applied to remaining pool jobs

object (ConfigQuery)

Filter jobs into this Job Segment based on various job object fields

targetCpa
integer <int32>

Goal CPA used by segments utilizing the Target CPA bidding strategy

emailAddress
string

Email address to which new Talroo Apply applicant emails will be sent

minCpc
integer <int32>

Minimum cost per click

talrooProCpc
integer <int32>

CPC used for Job Segments within Talroo Pro campaigns

enableAutoArchive
boolean

Whether this segment is eligible for auto archival

autoArchiveAt
string <date-time>

The timestamp at which the segment should be automatically archived

useSmartCpc
boolean

Flag indicating usage of recommended cpc api to set the bid on jobs filtered into this segment

autopilotMaxCpc
integer <int32>

Maximum CPC that can be set when using our Autopilot bidding strategy (overrides campaign-level value)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "basicCpc": 0,
  • "monthlyBudget": 0,
  • "applyOrder": 0,
  • "jobFilters": {
    },
  • "targetCpa": 0,
  • "emailAddress": "string",
  • "minCpc": 0,
  • "talrooProCpc": 0,
  • "enableAutoArchive": true,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "useSmartCpc": true,
  • "autopilotMaxCpc": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "name": "string",
  • "status": "ARCHIVED",
  • "applyOrder": 0,
  • "autoArchiveAt": "1970-01-01T00:00Z",
  • "autopilotMaxCpc": 0,
  • "basicCpc": 0,
  • "createdAt": "1970-01-01T00:00Z",
  • "emailAddress": "string",
  • "enableAutoArchive": true,
  • "events": {
    },
  • "jobFilters": {
    },
  • "jobs": {
    },
  • "minCpc": 0,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "monthlyBudget": 0,
  • "mtdSpend": 0,
  • "pool": {
    },
  • "report": {
    },
  • "scheduling": {
    },
  • "spending": {
    },
  • "talrooProCpc": 0,
  • "targetCpa": 0,
  • "useSmartCpc": true
}

Get my JobSegments

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=name,asc)

Supported fields (different for each endpoint)
id, name, status, applyOrder, mtdSpend, createdAt, modifiedAt, campaignId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, name, status, applyOrder, mtdSpend, createdAt, modifiedAt, campaignId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

report
Array of strings
Items Enum: "EVENTS" "JOBS" "POOL" "SCHEDULING" "SPENDING"
expand
Array of strings unique
Default: ""
Items Enum: "events" "jobs" "scheduling" "spending"
subCustomerId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Jobs

Get title suggestions for a Title And Description

Authorizations:
bearer
query Parameters
sortSetting
string
Enum: "BY_CTR" "BY_RELEVANCE"
blendWeight
number <double>
Default: 0.1
count
integer <int32>
Request Body schema: application/json
required
title
required
string
description
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "suggestions": [
    ]
}

Get Several Job's status with a List of ID's

Authorizations:
bearer
Request Body schema: application/json
required
ids
required
Array of strings

Platform Job IDs

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Generate LLM-based title suggestions from title and description

Authorizations:
bearer
Request Body schema: application/json
required
title
required
string
description
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "suggestions": [
    ]
}

Get a Job by ID

Authorizations:
bearer
path Parameters
id
required
string

Platform ID of Job

query Parameters
report
Array of strings
Items Value: "EXPANSION"

[Optional] Additional info related to the job

expand
Array of strings unique
Default: ""
Items Value: "expansion"

[Optional] Additional info related to the job

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "adType": "EVENT",
  • "atsJobId": "string",
  • "campaignId": 0,
  • "campaignName": "string",
  • "cities": [
    ],
  • "states": [
    ],
  • "company": "string",
  • "companyId": 0,
  • "customerId": 0,
  • "jobReference": "string",
  • "majorCategoryId": [
    ],
  • "majorCategoryName": [
    ],
  • "minorCategoryId": [
    ],
  • "minorCategoryName": [
    ],
  • "poolId": 0,
  • "segmentId": 0,
  • "segmentName": "string",
  • "sourceId": 0,
  • "status": "DAILY_CAPPED",
  • "title": "string",
  • "zipcodes": [
    ],
  • "derived": true,
  • "jobId": 0,
  • "isCpa": true,
  • "jobExpansionId": 0,
  • "originalJobReference": "string",
  • "description": "string",
  • "url": "string",
  • "eventStart": "1970-01-01",
  • "eventEnd": "1970-01-01",
  • "llmAllRequirements": [
    ],
  • "llmAllRequirementsNormalized": {
    },
  • "llmAllPreferences": [
    ],
  • "llmAllPreferencesNormalized": {
    },
  • "llmCompensation": [
    ],
  • "llmBenefits": [
    ],
  • "llmWorkSchedule": [
    ],
  • "llmWorkLocationType": [
    ],
  • "llmVisaStatus": [
    ],
  • "copiedLink": "string",
  • "facebookLink": "string",
  • "linkedinLink": "string",
  • "twitterLink": "string",
  • "emailLink": "string",
  • "report": {
    },
  • "expansion": {
    },
  • "subCustomerId": 0
}

Get title suggestions for a Job

Authorizations:
bearer
path Parameters
id
required
string
query Parameters
sortSetting
string
Enum: "BY_CTR" "BY_RELEVANCE"
blendWeight
number <double>
Default: 0.1
count
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "suggestions": [
    ]
}

Get a Job Status by ID

Authorizations:
bearer
path Parameters
id
required
string

Platform ID of Job

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "DAILY_CAPPED"
}

Get LLM-based title suggestions for a job

Authorizations:
bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "suggestions": [
    ]
}

Search my Jobs

Available Sort Fields: campaignName, campaign, cities, location, company, jobReference, majorCategory, majorCategoryName, minorCategory, minorCategoryName, segmentName, segment, states, title, zipcodes

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=adType,asc)

Supported fields (different for each endpoint)
id, adType, atsJobId, campaignId, campaignName, cities, states, company, companyId, customerId, jobReference, majorCategoryId, majorCategoryName, minorCategoryId, minorCategoryName, poolId, segmentId, segmentName, sourceId, status, title, zipcodes, derived, jobId, isCpa, description, url, eventStart, eventEnd, llmAllRequirements, llmAllRequirementsNormalized, llmAllPreferences, llmAllPreferencesNormalized, llmCompensation, llmBenefits, llmWorkSchedule, llmWorkLocationType, llmVisaStatus, subCustomerId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, adType, atsJobId, campaignId, campaignName, cities, states, company, companyId, customerId, jobReference, majorCategoryId, majorCategoryName, minorCategoryId, minorCategoryName, poolId, segmentId, segmentName, sourceId, status, title, zipcodes, derived, jobId, isCpa, description, url, eventStart, eventEnd, llmAllRequirements, llmAllRequirementsNormalized, llmAllPreferences, llmAllPreferencesNormalized, llmCompensation, llmBenefits, llmWorkSchedule, llmWorkLocationType, llmVisaStatus, subCustomerId

report
Array of strings
Items Value: "EXPANSION"

[Optional] Additional info related to the job

expand
Array of strings unique
Default: ""
Items Value: "expansion"

[Optional] Additional info related to the job

subCustomerId
integer <int32>

Sub Customer ID

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Drill down on my unique Job Titles

Search all unique Job Titles grouped by Source

Authorizations:
bearer
query Parameters
search
any

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

current
integer <int32>
next
integer <int32>
previous
integer <int32>
size
integer <int32> [ 0 .. 1000 ]
Default: 20
expand
Array of strings unique
Default: ""
Items Value: "expansion"

[Optional] Additional info related to the job

subCustomerId
integer <int32>

Sub Customer ID

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "metadata": {
    }
}

Locations - Cities

Get US Cities By US State

Authorizations:
bearer
path Parameters
stateId
required
integer <int32>

State ID. See Locations - States

query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=name,asc)

Supported fields (different for each endpoint)
id, name, cityState

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, name, cityState

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get US Cities By US County

Authorizations:
bearer
path Parameters
countyId
required
integer <int32>

County ID. See Locations - Counties

query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=name,asc)

Supported fields (different for each endpoint)
id, name, cityState

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, name, cityState

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get US Cities

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=name,asc)

Supported fields (different for each endpoint)
id, name, cityState

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, name, cityState

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get a US City by ID

Authorizations:
bearer
path Parameters
cityId
required
integer <int32>

City ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "cityState": "string",
  • "aliasOf": { },
  • "state": {
    },
  • "county": {
    }
}

Locations - Counties

Get US Counties by US State

Authorizations:
bearer
path Parameters
stateId
required
integer <int32>

State ID. See Locations - States

query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=name,asc)

Supported fields (different for each endpoint)
id, name

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, name

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get US Counties

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=name,asc)

Supported fields (different for each endpoint)
id, name

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, name

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get a US County by ID

Authorizations:
bearer
path Parameters
countyId
required
integer <int32>

County ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "state": {
    }
}

Locations - States

Get States

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=abbreviation,asc)

Supported fields (different for each endpoint)
id, abbreviation, name

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, abbreviation, name

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get a State by ID

Authorizations:
bearer
path Parameters
stateId
required
integer <int32>

State ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "abbreviation": "st",
  • "timeZone": "string",
  • "name": "string"
}

Locations - ZIP Codes

Get US ZipCodes

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=id,asc)

Supported fields (different for each endpoint)
id

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get a US ZipCode By ZipCode

Authorizations:
bearer
path Parameters
zipCode
required
integer <int32>

ZipCode - 5 digits

Responses

Response samples

Content type
application/json
{
  • "id": "strin",
  • "longitude": 0.1,
  • "latitude": 0.1,
  • "state": {
    },
  • "city": {
    }
}

Get US ZipCodes by US State

Authorizations:
bearer
path Parameters
stateId
required
integer <int32>

State ID. See Locations - States

query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=id,asc)

Supported fields (different for each endpoint)
id

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Get US ZipCodes by US City

Authorizations:
bearer
path Parameters
cityId
required
integer <int32>

City ID. See Locations - Cities

query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=id,asc)

Supported fields (different for each endpoint)
id

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

OAuth2

oauth2Token

Authorizations:
basic
header Parameters
Authorization
string
Request Body schema: application/json
required
One of
grantType
string
Enum: "CHALLENGE" "CLIENT_CREDENTIALS" "CODE" "PASSWORD"
code
required
string

Responses

Request samples

Content type
application/json
Example
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
Example
{
  • "accessToken": "string",
  • "tokenType": "string",
  • "expiresIn": 0,
  • "idToken": "string",
  • "challenge": "SMS_MFA"
}

Reports

getLiveJobCountBySegment

Authorizations:
bearer
query Parameters
search
any

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

next
integer <int32>
previous
integer <int32>
size
integer <int32> [ 0 .. 5000 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "metadata": {
    }
}

getLiveJobCountByCampaign

Authorizations:
bearer
query Parameters
search
any

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

next
integer <int32>
previous
integer <int32>
size
integer <int32> [ 0 .. 5000 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "metadata": {
    }
}

Scheduling - Monthly Budget Changes

Acknowledge a failed Monthly Budget Change

Authorizations:
bearer
path Parameters
monthlyBudgetChangeId
required
integer <int32>

Scheduled Monthly Budget Change ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "absolute": true,
  • "applyOn": "1970-01-01",
  • "budgetCents": 0,
  • "completed": true,
  • "createdAt": "1970-01-01T00:00Z",
  • "errorMessage": "string",
  • "failed": true,
  • "modifiedAt": "1970-01-01T00:00Z"
}

Get Monthly Budget Changes by Campaign

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>

Talroo Job Campaign ID

query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=applyOn,asc)

Supported fields (different for each endpoint)
id, applyOn, completed, failed, createdAt, modifiedAt, campaignId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, applyOn, completed, failed, createdAt, modifiedAt, campaignId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

subCustomerId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Create a Monthly Budget Change for a Campaign

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>

Talroo Job Campaign ID

Request Body schema: application/json
required
applyOn
string <date>

Date on which this new monthly budget is set to take effect

budgetCents
integer <int32>

The new monthly budget in cents

absolute
boolean

When absolute is TRUE, the Scheduled budget change will replace the current monthly budget with the set budgetCents value. When FALSE, it will adjust the current monthly budget with the set budgetCents value

Responses

Request samples

Content type
application/json
{
  • "applyOn": "1970-01-01",
  • "budgetCents": 0,
  • "absolute": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "absolute": true,
  • "applyOn": "1970-01-01",
  • "budgetCents": 0,
  • "completed": true,
  • "createdAt": "1970-01-01T00:00Z",
  • "errorMessage": "string",
  • "failed": true,
  • "modifiedAt": "1970-01-01T00:00Z"
}

Get a Monthly Budget Change by ID

Authorizations:
bearer
path Parameters
monthlyBudgetChangeId
required
integer <int32>

Scheduled Monthly Budget Change ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "absolute": true,
  • "applyOn": "1970-01-01",
  • "budgetCents": 0,
  • "completed": true,
  • "createdAt": "1970-01-01T00:00Z",
  • "errorMessage": "string",
  • "failed": true,
  • "modifiedAt": "1970-01-01T00:00Z"
}

Delete a Monthly Budget Change

Authorizations:
bearer
path Parameters
monthlyBudgetChangeId
required
integer <int32>

Scheduled Monthly Budget Change ID

Responses

Update a Monthly Budget Change

Authorizations:
bearer
path Parameters
monthlyBudgetChangeId
required
integer <int32>

Scheduled Monthly Budget Change ID

Request Body schema: application/json
required
applyOn
string <date>

Date on which this new monthly budget is set to take effect

budgetCents
integer <int32>

The new monthly budget in cents

absolute
boolean

When absolute is TRUE, the Scheduled budget change will replace the current monthly budget with the set budgetCents value. When FALSE, it will adjust the current monthly budget with the set budgetCents value

Responses

Request samples

Content type
application/json
{
  • "applyOn": "1970-01-01",
  • "budgetCents": 0,
  • "absolute": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "absolute": true,
  • "applyOn": "1970-01-01",
  • "budgetCents": 0,
  • "completed": true,
  • "createdAt": "1970-01-01T00:00Z",
  • "errorMessage": "string",
  • "failed": true,
  • "modifiedAt": "1970-01-01T00:00Z"
}

Get my Monthly Budget Changes

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=applyOn,asc)

Supported fields (different for each endpoint)
id, applyOn, completed, failed, createdAt, modifiedAt, campaignId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, applyOn, completed, failed, createdAt, modifiedAt, campaignId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

subCustomerId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Scheduling - One Time Budgets

Get OneTimeBudgets by Campaign

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>

Talroo Job Campaign ID

query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=start,asc)

Supported fields (different for each endpoint)
id, start, end, rollover, createdAt, modifiedAt, started, completed, launchOnStart, campaignId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, start, end, rollover, createdAt, modifiedAt, started, completed, launchOnStart, campaignId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

subCustomerId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Create a OneTimeBudget

NOTE: By default, non-LIVE Campaigns will be launched when the OneTimeBudget is started. To change this behavior, set the launchOnStart property in the request body to false.

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>

Talroo Job Campaign ID

Request Body schema: application/json
required
start
string <date>

Date on which this One Time Budget should be added to the campaign

budgetCents
integer <int32>

Amount of the One Time Budget in cents

rollover
boolean

Boolean indicating whether this One Time Budget should rollover unspent budget to the next month

launchOnStart
boolean

Boolean indicating whether this One Time Budget should have the ability to push the campaign live on its start date

Responses

Request samples

Content type
application/json
{
  • "start": "1970-01-01",
  • "budgetCents": 0,
  • "rollover": true,
  • "launchOnStart": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "budgetCents": 0,
  • "completed": true,
  • "createdAt": "1970-01-01T00:00Z",
  • "end": "1970-01-01",
  • "launchOnStart": true,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "rollover": true,
  • "start": "1970-01-01",
  • "started": true
}

Get a OneTimeBudget by ID

Authorizations:
bearer
path Parameters
oneTimeBudgetId
required
integer <int32>

One Time Budget ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "budgetCents": 0,
  • "completed": true,
  • "createdAt": "1970-01-01T00:00Z",
  • "end": "1970-01-01",
  • "launchOnStart": true,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "rollover": true,
  • "start": "1970-01-01",
  • "started": true
}

Delete a OneTimeBudget

Authorizations:
bearer
path Parameters
oneTimeBudgetId
required
integer <int32>

One Time Budget ID

Responses

Update a OneTimeBudget

NOTE: By default, non-LIVE Campaigns will be launched when the OneTimeBudget is started. To change this behavior, set the launchOnStart property in the request body to false.

Authorizations:
bearer
path Parameters
oneTimeBudgetId
required
integer <int32>

One Time Budget ID

Request Body schema: application/json
required
start
string <date>

Date on which this One Time Budget should be added to the campaign

budgetCents
integer <int32>

Amount of the One Time Budget in cents

rollover
boolean

Boolean indicating whether this One Time Budget should rollover unspent budget to the next month

launchOnStart
boolean

Boolean indicating whether this One Time Budget should have the ability to push the campaign live on its start date

Responses

Request samples

Content type
application/json
{
  • "start": "1970-01-01",
  • "budgetCents": 0,
  • "rollover": true,
  • "launchOnStart": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "budgetCents": 0,
  • "completed": true,
  • "createdAt": "1970-01-01T00:00Z",
  • "end": "1970-01-01",
  • "launchOnStart": true,
  • "modifiedAt": "1970-01-01T00:00Z",
  • "rollover": true,
  • "start": "1970-01-01",
  • "started": true
}

Get my OneTimeBudgets

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=start,asc)

Supported fields (different for each endpoint)
id, start, end, rollover, createdAt, modifiedAt, started, completed, launchOnStart, campaignId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, start, end, rollover, createdAt, modifiedAt, started, completed, launchOnStart, campaignId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

subCustomerId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Scheduling - Pauses

Get Platform Scheduled Pause by Segment ID

Authorizations:
bearer
path Parameters
segmentId
required
integer <int32>

Talroo Job Segment ID

query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=pauseOn,asc)

Supported fields (different for each endpoint)
id, pauseOn, completed, createdAt, modifiedAt, campaignId, segmentId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, pauseOn, completed, createdAt, modifiedAt, campaignId, segmentId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

subCustomerId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Create a Platform Scheduled Pause for a Segment

Authorizations:
bearer
path Parameters
segmentId
required
integer <int32>

Talroo Job Segment ID

Request Body schema: application/json
required
pauseOn
string <date>

Date on which the corresponding Talroo Job Campaign, or Talroo Job Segment, should be paused

pauseReasonId
integer <int32>

[Optional] Pause Reason ID. See Enum - Pause Reasons

Responses

Request samples

Content type
application/json
{
  • "pauseOn": "1970-01-01",
  • "pauseReasonId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "segmentId": 0,
  • "completed": true,
  • "createdAt": "1970-01-01T00:00Z",
  • "modifiedAt": "1970-01-01T00:00Z",
  • "pauseOn": "1970-01-01",
  • "pauseReason": {
    },
  • "pauseReasonId": 0
}

Get Platform Scheduled Pause by Campaign ID

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>

Talroo Job Campaign ID

query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=pauseOn,asc)

Supported fields (different for each endpoint)
id, pauseOn, completed, createdAt, modifiedAt, campaignId, segmentId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, pauseOn, completed, createdAt, modifiedAt, campaignId, segmentId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

subCustomerId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Create a Platform Scheduled Pause

Authorizations:
bearer
path Parameters
campaignId
required
integer <int32>

Talroo Job Campaign ID

Request Body schema: application/json
required
pauseOn
string <date>

Date on which the corresponding Talroo Job Campaign, or Talroo Job Segment, should be paused

pauseReasonId
integer <int32>

[Optional] Pause Reason ID. See Enum - Pause Reasons

Responses

Request samples

Content type
application/json
{
  • "pauseOn": "1970-01-01",
  • "pauseReasonId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "segmentId": 0,
  • "completed": true,
  • "createdAt": "1970-01-01T00:00Z",
  • "modifiedAt": "1970-01-01T00:00Z",
  • "pauseOn": "1970-01-01",
  • "pauseReason": {
    },
  • "pauseReasonId": 0
}

Get a Scheduled Pause by ID

Authorizations:
bearer
path Parameters
pauseId
required
integer <int32>

Scheduled Pause ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "segmentId": 0,
  • "completed": true,
  • "createdAt": "1970-01-01T00:00Z",
  • "modifiedAt": "1970-01-01T00:00Z",
  • "pauseOn": "1970-01-01",
  • "pauseReason": {
    },
  • "pauseReasonId": 0
}

Delete a Scheduled Pause

Authorizations:
bearer
path Parameters
pauseId
required
integer <int32>

Scheduled Pause ID

Responses

Update a Platform Scheduled Pause

Authorizations:
bearer
path Parameters
pauseId
required
integer <int32>

Scheduled Pause ID

Request Body schema: application/json
required
pauseOn
string <date>

Date on which the corresponding Talroo Job Campaign, or Talroo Job Segment, should be paused

pauseReasonId
integer <int32>

[Optional] Pause Reason ID. See Enum - Pause Reasons

Responses

Request samples

Content type
application/json
{
  • "pauseOn": "1970-01-01",
  • "pauseReasonId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "campaignId": 0,
  • "segmentId": 0,
  • "completed": true,
  • "createdAt": "1970-01-01T00:00Z",
  • "modifiedAt": "1970-01-01T00:00Z",
  • "pauseOn": "1970-01-01",
  • "pauseReason": {
    },
  • "pauseReasonId": 0
}

Get my Scheduled Pauses

Authorizations:
bearer
query Parameters
page
number >= 0
Default: 0

Zero-based page index (0..N)

size
number >= 1
Default: 20

The size of the page to be returned

sort
Array of strings
Example: sort=id,asc

Sorting criteria (more info)
Format: field,(asc|desc)
Default sort order is ascending. Multiple sort criteria are supported (ex: &sort=id,desc&sort=pauseOn,asc)

Supported fields (different for each endpoint)
id, pauseOn, completed, createdAt, modifiedAt, campaignId, segmentId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

search
string

Filtering criteria (more info)
Format: field=value (complex grammar including expression predicates that can be combined)

Supported fields (different for each endpoint)
id, pauseOn, completed, createdAt, modifiedAt, campaignId, segmentId
Nested fields
campaign.id, campaign.modifiedAt, campaign.status, campaign.mtdSpend, campaign.createdAt, campaign.name, campaign.applyOrder, campaign.adType, campaign.pool.id, campaign.pool.createdAt, campaign.pool.name, campaign.pool.isCpa, campaign.pool.modifiedAt, campaign.pool.customer.id, campaign.pool.customer.createdAt, campaign.pool.customer.name, campaign.pool.customer.modifiedAt, campaign.pool.customerId, campaign.poolId

subCustomerId
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "totalPages": 0,
  • "totalElements": 0
}

Status

status

Responses

Response samples

Content type
application/json
{
  • "status": "DEGRADED",
  • "version": "string",
  • "details": {
    },
  • "maintenance": {
    }
}