This page outlines all endpoints that are publicly available to use. If you have any additional questions on these endpoints please reach out to the Support team via the in-platform widget or via the Zendesk widget.
Rate limits do apply to some of these endpoints. See here for more.
Note on notation: anything shown inside double curly braces, such as {{enterprise}} or {{leadId}}, is a placeholder. Replace it (including the braces) with your own value.
Authentication
These APIs use OAuth2 with the password credentials grant. You authenticate against the login endpoint to obtain an access token, then send that token in the request header for authenticated calls.
Token endpoint: POST https://{{enterprise}}.cvtr.io/api/login
Credentials: your username and password must be sent in the body of the login request (not as a header and not in the URL).
Access token: the login response returns an access token, which you then add to the request header on authenticated calls.
Note: The Flag lead as invalid, Flag lead as valid, and Append/Edit Data endpoints do not require the access token (they are configured as no-auth in this collection).
Sample request:
curl --location 'https://{{enterprise}}.cvtr.io/api/login' \
--data-urlencode 'username={{username}}' \
--data-urlencode 'password={{password}}'Sample response (success, 200): values shown are examples and have been masked:
{
"access_token": "<access_token>",
"expires_in": 3600,
"token_type": "bearer",
"scope": null,
"refresh_token": "<refresh_token>",
"client_id": "<client_id>",
"client_secret": "<client_secret>",
"user_id": 0,
"password_expired": false,
"expires_ts": 1785166537
}Sample response (error, 400): returned when the credentials are incorrect:
{
"error": "invalid_grant",
"error_description": "Invalid username and password combination"
}
Endpoints
Get all Campaigns
GET https://{{enterprise}}.cvtr.io/api/v4/campaigns
Responses:
| Status | Meaning |
|---|---|
200 |
Returns a hydra collection. The example below is trimmed to two campaigns; the live response paginates (see hydra:view) and includes the full list of available filter and sort parameters (see hydra:search). |
401 |
Access token is invalid. |
Sample request:
curl --location 'https://{{enterprise}}.cvtr.io/api/v4/campaigns' \
--header 'Authorization: Bearer {{accessToken}}'Sample response (success, 200): sensitive values have been masked with placeholders:
{
"@context": "/api/v4/contexts/Campaign",
"@id": "/api/v4/campaigns",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/api/v4/campaigns/44676",
"@type": "Campaign",
"id": 44676,
"name": "Test",
"startTs": "2026-07-21T00:00:00+01:00",
"endTs": "2026-07-22T23:59:59+01:00",
"endTsExtension": 0,
"exposePublisher": false,
"exposePublisherSub": false,
"updatedTs": "2026-07-21T16:13:34+01:00",
"defaultThresholdScore": 70,
"manualScore": false,
"combinedJobScore": 880,
"integrate": true,
"pauseTs": null,
"pauseReason": null,
"callCentre": false,
"welcomeEmail": false,
"autoSignPublisher": false,
"excludeFromAiInsights": false,
"sendMediakit": true,
"doubleOptin": false,
"scoreBaseRouting": false,
"valueBasedRouting": false,
"holdPublisherOverDelivery": false,
"acceptLinkedInLeadsIfInactive": true,
"defaultSaleValue": "0.01",
"defaultSaleCurrency": "GBP",
"useValueTransforms": false,
"sendVoucher": false,
"testMode": false,
"uncapped": false,
"leadsRequired": 1000,
"baseCurrencyPayoutAmount": "20.00",
"payoutAmount": "20.00",
"payout": "CPL",
"currency": {
"@id": "/api/v4/currencies/3",
"@type": "Currency",
"id": 3,
"name": "USD",
"symbol": "$",
"base": false,
"rateToBase": "1.0000"
},
"conversionRate": "1.0000",
"advertiser": {
"@id": "/api/v4/advertisers/22108",
"@type": "Advertiser",
"id": 22108,
"name": "Example Advertiser 2"
},
"campaignManager": null,
"accountManager": null,
"subcategory": {
"@id": "/api/v4/subcategories/1",
"@type": "Subcategory",
"id": 1,
"name": "Test Sub Category"
},
"performanceModel": "full",
"baseCurrencyContractValue": "20000.00",
"contractValue": "20000.00",
"campaignMarket": "b2b",
"internalOnly": false,
"variablePublisherPayout": false,
"campaignType": {
"@id": "/api/v4/campaign-types/2",
"@type": "CampaignType",
"id": 2,
"name": "Content Syndication",
"description": "BANT, ABM, double touch, lead gen campaigns via syndication partners"
},
"defaultPublisherRate": 100,
"publisherPayoutType": "CPL",
"publisherTerms": "<p>Example publisher default contract terms.</p>",
"country": {
"@id": "/api/v4/countries/226",
"@type": "Country",
"id": 226,
"iso": "US",
"name": "UNITED STATES",
"displayName": "United States"
},
"unavailableCampaignLogic": "allow_leads",
"unavailableCampaignRedirectUrl": null,
"useScheduledDeliveryV2": false,
"leadProcessDelay": 0,
"facebookOfflineEventSetId": null,
"facebookSystemUserAccessToken": null,
"apiKey": "<api_key>",
"notes": null,
"signName": "Example Signer",
"signRole": "AUTO SIGNED",
"signTs": "2026-07-21T16:13:33+01:00",
"signIoNumber": null,
"signHash": "<sign_hash>",
"terms": "Example advertiser default contract terms.",
"statistics": {
"totalLeads": 0,
"invalidLeads": 0,
"cautionLeads": 0,
"validLeads": 0,
"billableLeads": 0,
"deliveredLeads": 0,
"heldLeads": 0,
"pendingBatch": 0,
"processingLeads": 0,
"impressions": 0,
"conversions": 0,
"lastConversion": "",
"clicks": 0,
"activePublishers": 0,
"totalSales": 0,
"campaignRevenue": {
"baseCurrencyRevenue": "0.00",
"publisherPayout": "0.00",
"baseCurrencyPublisherPayout": "0.00",
"revenueRemaining": "20000.00",
"revenue": "0.00"
},
"unsignedContracts": 0
},
"status": "Ended",
"allowPublisherImportExport": false,
"allowBulkEdit": false,
"purchaseOrder": null,
"purchaseOrderFile": null,
"referenceNumber": null,
"shareScheduledDeliveryWithPublishers": false,
"defaultInvalidateWebhookReason": null,
"staleLeadThresholdDays": null,
"campaignDatas": [],
"hasUncommunicatedChangesSinceTs": null,
"isTemplate": false,
"jobsToReview": 0,
"convertrConnectConfig": null
},
{
"@id": "/api/v4/campaigns/44674",
"@type": "Campaign",
"id": 44674,
"name": "Test 2",
"startTs": "2026-07-06T00:00:00+01:00",
"endTs": "2026-07-30T23:59:59+01:00",
"endTsExtension": null,
"exposePublisher": false,
"exposePublisherSub": false,
"updatedTs": "2026-07-06T14:27:05+01:00",
"defaultThresholdScore": 70,
"manualScore": false,
"combinedJobScore": 20,
"integrate": true,
"pauseTs": null,
"pauseReason": null,
"callCentre": false,
"welcomeEmail": false,
"autoSignPublisher": false,
"excludeFromAiInsights": false,
"sendMediakit": true,
"doubleOptin": false,
"scoreBaseRouting": false,
"valueBasedRouting": true,
"holdPublisherOverDelivery": false,
"acceptLinkedInLeadsIfInactive": true,
"defaultSaleValue": "0.01",
"defaultSaleCurrency": "GBP",
"useValueTransforms": true,
"sendVoucher": false,
"testMode": false,
"uncapped": false,
"leadsRequired": 100,
"baseCurrencyPayoutAmount": "12.00",
"payoutAmount": "12.00",
"payout": "CPL",
"currency": {
"@id": "/api/v4/currencies/1",
"@type": "Currency",
"id": 1,
"name": "GBP",
"symbol": "£",
"base": true,
"rateToBase": "1.0000"
},
"conversionRate": "1.0000",
"advertiser": {
"@id": "/api/v4/advertisers/22041",
"@type": "Advertiser",
"id": 22041,
"name": "Example Advertiser 1"
},
"campaignManager": null,
"accountManager": null,
"subcategory": {
"@id": "/api/v4/subcategories/3",
"@type": "Subcategory",
"id": 3,
"name": "Test"
},
"performanceModel": "full",
"baseCurrencyContractValue": "1200.00",
"contractValue": "1200.00",
"campaignMarket": "b2b",
"internalOnly": false,
"variablePublisherPayout": true,
"campaignType": {
"@id": "/api/v4/campaign-types/2",
"@type": "CampaignType",
"id": 2,
"name": "Content Syndication",
"description": "BANT, ABM, double touch, lead gen campaigns via syndication partners"
},
"defaultPublisherRate": 100,
"publisherPayoutType": "CPL",
"publisherTerms": "<p>Example publisher default contract terms.</p>",
"country": null,
"unavailableCampaignLogic": "allow_leads",
"unavailableCampaignRedirectUrl": null,
"useScheduledDeliveryV2": false,
"leadProcessDelay": 0,
"facebookOfflineEventSetId": "<facebook_event_set_id>",
"facebookSystemUserAccessToken": "<facebook_access_token>",
"apiKey": "<api_key>",
"notes": null,
"signName": "Example Signer",
"signRole": "AUTO SIGNED",
"signTs": "2026-07-06T10:26:18+01:00",
"signIoNumber": null,
"signHash": "<sign_hash>",
"terms": "Example advertiser default contract terms.",
"statistics": {
"totalLeads": 3,
"invalidLeads": 0,
"cautionLeads": 0,
"validLeads": 3,
"billableLeads": 0,
"deliveredLeads": 0,
"heldLeads": 0,
"pendingBatch": 0,
"processingLeads": 0,
"impressions": 0,
"conversions": 0,
"lastConversion": "",
"clicks": 0,
"activePublishers": 0,
"totalSales": 0,
"campaignRevenue": {
"baseCurrencyRevenue": "0.00",
"publisherPayout": "0.00",
"baseCurrencyPublisherPayout": "0.00",
"revenueRemaining": "1200.00",
"revenue": "0.00"
},
"unsignedContracts": 2
},
"status": "Active",
"allowPublisherImportExport": true,
"allowBulkEdit": true,
"purchaseOrder": null,
"purchaseOrderFile": null,
"referenceNumber": null,
"shareScheduledDeliveryWithPublishers": false,
"defaultInvalidateWebhookReason": null,
"staleLeadThresholdDays": null,
"campaignDatas": [],
"hasUncommunicatedChangesSinceTs": "2026-07-06T10:27:09+01:00",
"isTemplate": false,
"jobsToReview": 0,
"convertrConnectConfig": {
"@id": "/api/v4/campaign-convertr-connect-configs/12",
"@type": "CampaignConvertrConnectConfig",
"id": 12,
"campaign": "/api/v4/campaigns/44674",
"credentials": {
"@id": "/api/v4/connected-app-accounts/32",
"@type": "ConnectedAppAccount",
"id": 32,
"clientId": null,
"apiUrl": "example",
"metadata": [],
"name": "Example Connected App",
"updatedTs": "2026-07-06T10:26:20+01:00"
},
"targetPublisherId": 0,
"targetCampaignId": 0,
"targetLinkId": null,
"targetFormId": 0,
"mapping": {
"form[email]": "email",
"form[country]": "country",
"form[lastName]": "lastName",
"form[firstName]": "firstName",
"form[telephone]": "telephone",
"form[company_name]": "",
"form[number_of_employees]": "employee_size",
"form[how_awesome_is_this_campaign]": ""
}
}
}
],
"hydra:totalItems": 525,
"hydra:view": {
"@id": "/api/v4/campaigns?page=1",
"@type": "hydra:PartialCollectionView",
"hydra:first": "/api/v4/campaigns?page=1",
"hydra:last": "/api/v4/campaigns?page=53",
"hydra:next": "/api/v4/campaigns?page=2"
},
"hydra:search": {
"@type": "hydra:IriTemplate",
"hydra:template": "/api/v4/campaigns{?id,id[],name,order[id],order[name],createdTs[before],createdTs[strictly_before],createdTs[after],createdTs[strictly_after],updatedTs[before],updatedTs[strictly_before],updatedTs[after],updatedTs[strictly_after],startTs[before],startTs[strictly_before],startTs[after],startTs[strictly_after],endTs[before],endTs[strictly_before],endTs[after],endTs[strictly_after],order[statistics.invalidLeads],order[statistics.validLeads],order[statistics.cautionLeads],order[statistics.heldLeads],order[statistics.processingLeads],order[statistics.billableLeads],order[statistics.impressions],order[statistics.conversions],order[statistics.clicks],status[],order[advertiser.name],order[startTs],order[endTs],order[referenceNumber],order[accountManager],order[campaignManager],order[purchaseOrder],order[country.id],order[country.iso],order[statistics.activePublishers],order[statistics.totalSales],order[statistics.campaignRevenue.revenue],order[statistics.campaignRevenue.baseCurrencyRevenue],agency.id,idName,forms.form.id[neq],forms.form.id[neq][],id[neq],id[neq][],campaignProcessrJobs.visible,campaignProcessrJobs.visible[],campaignProcessrJobs.processrJob.id,campaignProcessrJobs.processrJob.id[],purchaseOrder,referenceNumber,subcategory.id,subcategory.id[],subcategory.category.id,subcategory.category.id[],campaignPublishers.publisher.id,campaignPublishers.publisher.id[],advertiser.id,advertiser.id[],advertiser.name,campaignManager,accountManager,country.id,country.id[],country.iso,country.iso[],integrate,useScheduledDeliveryV2,isTemplate,properties[]}",
"hydra:variableRepresentation": "BasicRepresentation",
"hydra:mapping": [
{
"@type": "IriTemplateMapping",
"variable": "id",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "id[]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "name",
"property": "name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[id]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[name]",
"property": "name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTs[before]",
"property": "createdTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTs[strictly_before]",
"property": "createdTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTs[after]",
"property": "createdTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTs[strictly_after]",
"property": "createdTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[before]",
"property": "updatedTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[strictly_before]",
"property": "updatedTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[after]",
"property": "updatedTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[strictly_after]",
"property": "updatedTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "startTs[before]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "startTs[strictly_before]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "startTs[after]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "startTs[strictly_after]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "endTs[before]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "endTs[strictly_before]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "endTs[after]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "endTs[strictly_after]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.invalidLeads]",
"property": "statistics.invalidLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.validLeads]",
"property": "statistics.validLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.cautionLeads]",
"property": "statistics.cautionLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.heldLeads]",
"property": "statistics.heldLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.processingLeads]",
"property": "statistics.processingLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.billableLeads]",
"property": "statistics.billableLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.impressions]",
"property": "query",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.conversions]",
"property": "statistics.conversions",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.clicks]",
"property": "statistics.clicks",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "status[]",
"property": "status",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[advertiser.name]",
"property": "advertiser.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[startTs]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[endTs]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[referenceNumber]",
"property": "referenceNumber",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[accountManager]",
"property": "accountManager",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[campaignManager]",
"property": "campaignManager",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[purchaseOrder]",
"property": "purchaseOrder",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[country.id]",
"property": "country.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[country.iso]",
"property": "country.iso",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.activePublishers]",
"property": "statistics.activePublishers",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.totalSales]",
"property": "statistics.totalSales",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.campaignRevenue.revenue]",
"property": "statistics.campaignRevenue.revenue",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.campaignRevenue.baseCurrencyRevenue]",
"property": "statistics.campaignRevenue.baseCurrencyRevenue",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "agency.id",
"property": "agency.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "idName",
"property": "idName",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "forms.form.id[neq]",
"property": "forms.form.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "forms.form.id[neq][]",
"property": "forms.form.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "id[neq]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "id[neq][]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignProcessrJobs.visible",
"property": "campaignProcessrJobs.visible",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignProcessrJobs.visible[]",
"property": "campaignProcessrJobs.visible",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignProcessrJobs.processrJob.id",
"property": "campaignProcessrJobs.processrJob.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignProcessrJobs.processrJob.id[]",
"property": "campaignProcessrJobs.processrJob.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "purchaseOrder",
"property": "purchaseOrder",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "referenceNumber",
"property": "referenceNumber",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "subcategory.id",
"property": "subcategory.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "subcategory.id[]",
"property": "subcategory.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "subcategory.category.id",
"property": "subcategory.category.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "subcategory.category.id[]",
"property": "subcategory.category.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignPublishers.publisher.id",
"property": "campaignPublishers.publisher.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignPublishers.publisher.id[]",
"property": "campaignPublishers.publisher.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiser.id",
"property": "advertiser.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiser.id[]",
"property": "advertiser.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiser.name",
"property": "advertiser.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignManager",
"property": "campaignManager",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "accountManager",
"property": "accountManager",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "country.id",
"property": "country.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "country.id[]",
"property": "country.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "country.iso",
"property": "country.iso",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "country.iso[]",
"property": "country.iso",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "integrate",
"property": "integrate",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "useScheduledDeliveryV2",
"property": "useScheduledDeliveryV2",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "isTemplate",
"property": "isTemplate",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "properties[]",
"property": null,
"required": false
}
]
}
}Sample response (error, 401): the server returns the response body below:
{
"message": "An authentication exception occurred."
}Get all Leads
GET https://{{enterprise}}.cvtr.io/api/v4/leads
Responses:
| Status | Meaning |
|---|---|
200 |
Returns a hydra collection. The example below is trimmed to two leads; the live response paginates (see hydra:view) and includes the full list of available filter and sort parameters (see hydra:search). |
401 |
Access token is invalid. |
Sample request:
curl --location 'https://{{enterprise}}.cvtr.io/api/v4/leads' \
--header 'Authorization: Bearer {{accessToken}}'Sample response (success, 200): sensitive values have been masked with placeholders:
{
"@context": "/api/v4/contexts/Lead",
"@id": "/api/v4/leads",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/api/v4/leads/45679",
"@type": "Lead",
"id": 45679,
"publisherSubId": null,
"channel": null,
"formHash": null,
"createdTs": "2026-07-23T16:53:40+01:00",
"postcode": "",
"addressLine1": "",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"title": "",
"firstName": "",
"lastName": "",
"email": "example.lead@example.com",
"telephone": "",
"dob": null,
"sex": "",
"photo": "",
"ip": "203.0.113.10, 198.51.100.20",
"host": null,
"optIn": true,
"doubleOptIn": false,
"integration": true,
"overAllocation": "",
"visible": true,
"processrStatus": 1000,
"score": 0,
"hardfail": false,
"maxScore": 0,
"processingCounter": 1,
"suppressionList": false,
"imported": false,
"firstDeliveredTs": "2026-07-23T16:53:46+01:00",
"firstIntegrationTs": "2026-07-23T15:53:45+01:00",
"emailHash": null,
"fingerprint": null,
"baseCurrencyPublisherPayout": null,
"publisherPayout": null,
"baseCurrencyAdvertiserPayout": "50.00",
"advertiserPayout": "50.00",
"publisherBillable": false,
"advertiserBillable": true,
"saleValue": null,
"updatedTs": "2026-07-23T16:53:46+01:00",
"campaingSales": [],
"campaign": {
"@id": "/api/v4/campaigns/44664",
"@type": "Campaign",
"id": 44664,
"name": "Example Campaign",
"advertiser": {
"@id": "/api/v4/advertisers/22107",
"@type": "Advertiser",
"id": 22107,
"name": "Example Advertiser 1"
}
},
"campaignForm": null,
"globalForm": {
"@id": "/api/v4/forms/8278",
"@type": "Form",
"id": 8278,
"name": "Example Form",
"slug": "example-form"
},
"publisher": null,
"campaignLink": null,
"trackClick": null,
"qaResult": {
"@id": "/api/v4/lead-qa-results/1",
"@type": "LeadQaResult",
"name": "Valid"
},
"leadStatus": {
"@id": "/api/v4/lead-statuses/1",
"@type": "LeadStatus",
"name": "Valid"
},
"campaignPublisherBand": null,
"advertiserIO": null,
"whitepaper": null,
"entryPoint": "form",
"landingPageUrl": null,
"failedJobCount": 0,
"leadContactHistory": [],
"leadHash": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"leadMetadataReason": null,
"leadFlag": null,
"leadData": [
{
"@id": "/api/v4/lead-datas/1321596",
"@type": "LeadData",
"type": "core.data",
"name": "emailDomain",
"value": "@example.com",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321597",
"@type": "LeadData",
"type": "core.data",
"name": "createdDate",
"value": "2026-07-23",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321598",
"@type": "LeadData",
"type": "core.data",
"name": "createdYear",
"value": "2026",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321599",
"@type": "LeadData",
"type": "core.data",
"name": "createdMonth",
"value": "Jul",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321600",
"@type": "LeadData",
"type": "core.data",
"name": "leadHash",
"value": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321601",
"@type": "LeadData",
"type": "core.data",
"name": "msDynamicsLeadId",
"value": "<ms_dynamics_lead_id>",
"source": "MsDynamics365"
}
],
"integrationResults": [
{
"@id": "/api/v4/processr-job-leads/147933",
"@type": "ProcessrJobLead",
"id": 147933,
"passed": true,
"createdTs": "2026-07-23 16:53:43",
"executedTs": "2026-07-23 16:53:45",
"alwaysDeliver": false
}
]
},
{
"@id": "/api/v4/leads/45677",
"@type": "Lead",
"id": 45677,
"publisherSubId": null,
"channel": null,
"formHash": null,
"createdTs": "2026-07-15T18:02:24+01:00",
"postcode": "",
"addressLine1": "123 Example Street",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"title": "",
"firstName": "",
"lastName": "",
"email": "example.lead@example.com",
"telephone": "",
"dob": null,
"sex": "",
"photo": "",
"ip": "203.0.113.10",
"host": null,
"optIn": false,
"doubleOptIn": false,
"integration": false,
"overAllocation": "",
"visible": true,
"processrStatus": 1000,
"score": 20,
"hardfail": false,
"maxScore": 20,
"processingCounter": 1,
"suppressionList": false,
"imported": true,
"firstDeliveredTs": null,
"firstIntegrationTs": null,
"emailHash": null,
"fingerprint": null,
"baseCurrencyPublisherPayout": null,
"publisherPayout": null,
"baseCurrencyAdvertiserPayout": null,
"advertiserPayout": null,
"publisherBillable": false,
"advertiserBillable": false,
"saleValue": null,
"updatedTs": "2026-07-15T18:02:29+01:00",
"campaingSales": [],
"campaign": {
"@id": "/api/v4/campaigns/44674",
"@type": "Campaign",
"id": 44674,
"name": "Example Campaign",
"advertiser": {
"@id": "/api/v4/advertisers/22041",
"@type": "Advertiser",
"id": 22041,
"name": "Example Advertiser 2"
}
},
"campaignForm": null,
"globalForm": {
"@id": "/api/v4/forms/8147",
"@type": "Form",
"id": 8147,
"name": "Example Form",
"slug": "example-form"
},
"publisher": null,
"campaignLink": null,
"trackClick": null,
"qaResult": {
"@id": "/api/v4/lead-qa-results/1",
"@type": "LeadQaResult",
"name": "Valid"
},
"leadStatus": {
"@id": "/api/v4/lead-statuses/1",
"@type": "LeadStatus",
"name": "Valid"
},
"campaignPublisherBand": null,
"advertiserIO": null,
"whitepaper": {
"@id": "/api/v4/assets/21",
"@type": "Asset",
"advertiser": {
"@id": "/api/v4/advertisers/22041",
"@type": "Advertiser",
"id": 22041,
"name": "Example Advertiser 2"
},
"baseLocaleThumbnail": {
"@context": "/api/v4/contexts/File",
"@id": "/api/v4/files/863",
"@type": "File",
"id": 863,
"name": "example-asset.jpg",
"path": "example/example-asset.jpg",
"extension": "jpg",
"mimeType": "image/jpeg",
"url": "https://cdn.example.com/example-asset.jpg"
},
"baseLocaleDownload": {
"@context": "/api/v4/contexts/File",
"@id": "/api/v4/files/864",
"@type": "File",
"id": 864,
"name": "example-asset.pdf",
"path": "example/example-asset.pdf",
"extension": "pdf",
"mimeType": "application/pdf",
"url": "https://cdn.example.com/example-asset.pdf"
}
},
"entryPoint": "import",
"landingPageUrl": null,
"failedJobCount": 0,
"leadContactHistory": [],
"leadHash": "b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
"leadMetadataReason": null,
"leadFlag": null,
"leadData": [
{
"@id": "/api/v4/lead-datas/1321538",
"@type": "LeadData",
"type": "core.data",
"name": "emailDomain",
"value": "@example.com",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321539",
"@type": "LeadData",
"type": "core.data",
"name": "createdDate",
"value": "2026-07-15",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321540",
"@type": "LeadData",
"type": "core.data",
"name": "createdYear",
"value": "2026",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321541",
"@type": "LeadData",
"type": "core.data",
"name": "createdMonth",
"value": "Jul",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321542",
"@type": "LeadData",
"type": "core.data",
"name": "country",
"value": "US",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321543",
"@type": "LeadData",
"type": "core.data",
"name": "asset",
"value": "example-asset",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321544",
"@type": "LeadData",
"type": "core.data",
"name": "utm_campaign",
"value": "example-campaign",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321545",
"@type": "LeadData",
"type": "core.data",
"name": "whitepaperId",
"value": "21",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321546",
"@type": "LeadData",
"type": "core.data",
"name": "whitepaperName",
"value": "Example Whitepaper",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321547",
"@type": "LeadData",
"type": "core.data",
"name": "campaignWhitepaperRef",
"value": "58",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321548",
"@type": "LeadData",
"type": "core.data",
"name": "whitepaperTags",
"value": "",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321549",
"@type": "LeadData",
"type": "core.data",
"name": "whitepaperCategories",
"value": "Example Category",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321550",
"@type": "LeadData",
"type": "core.data",
"name": "whitepaperSubcategories",
"value": "Example Subcategory",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321551",
"@type": "LeadData",
"type": "core.data",
"name": "whitepaperLocale",
"value": "1",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321552",
"@type": "LeadData",
"type": "core.data",
"name": "importCreatedByUsername",
"value": "example.user",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321553",
"@type": "LeadData",
"type": "core.data",
"name": "importCreatedById",
"value": "157",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321554",
"@type": "LeadData",
"type": "core.data",
"name": "importFilename",
"value": "00000-00000000000000-example.user.csv",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321555",
"@type": "LeadData",
"type": "core.data",
"name": "importFileId",
"value": "2165",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321556",
"@type": "LeadData",
"type": "core.data",
"name": "leadHash",
"value": "b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1321573",
"@type": "LeadData",
"type": "core.data",
"name": "zoomInfoContactId",
"value": "<zoominfo_contact_id>",
"source": "publisher"
}
],
"integrationResults": []
}
],
"hydra:totalItems": 27935,
"hydra:view": {
"@id": "/api/v4/leads?page=1",
"@type": "hydra:PartialCollectionView",
"hydra:first": "/api/v4/leads?page=1",
"hydra:last": "/api/v4/leads?page=2794",
"hydra:next": "/api/v4/leads?page=2"
},
"hydra:search": {
"@type": "hydra:IriTemplate",
"hydra:template": "/api/v4/leads{?order[id],createdTs[before],createdTs[strictly_before],createdTs[after],createdTs[strictly_after],updatedTs[before],updatedTs[strictly_before],updatedTs[after],updatedTs[strictly_after],order[id],order[channel.id],order[score],order[advertiserPayout],order[email],exists[leadFlag],exists[publisher],advertiserPayout[between],advertiserPayout[gt],advertiserPayout[gte],advertiserPayout[lt],advertiserPayout[lte],publisherPayout[between],publisherPayout[gt],publisherPayout[gte],publisherPayout[lt],publisherPayout[lte],advertiserBillable,publisherBillable,id,id[],integration,integration[],publisher.name,campaign.id,campaign.id[],campaign.name,campaignLink.channel.name,campaignLink.channel.name[],processrStatus,processrStatus[],leadFlag.id,leadFlag.id[],qaResult.id,qaResult.id[],leadStatus.id,leadStatus.id[],campaignForm.id,campaignForm.id[],campaignForm.name,campaignForm.slug,campaign.advertiser.id,campaign.advertiser.id[],campaign.advertiser.name,postcode,addressLine1,addressLine2,addressLine3,addressLine4,title,firstName,lastName,telephone,sex,photo,leadContactHistoryCurrentStatus,leadContactHistoryCallNumber,leadData.name,leadData.type,leadData.source,leadData.depth,leadData.value,leadDataName[],campaignProcessrJobsPassed,processrJobsPassed,campaignProcessrJobsFailed,processrJobsFailed,firstDeliveredTs[before],firstDeliveredTs[strictly_before],firstDeliveredTs[after],firstDeliveredTs[strictly_after],currentLeadFlagHistory.leadFlagReason.id,currentLeadFlagHistory.leadFlagReason.id[],email}",
"hydra:variableRepresentation": "BasicRepresentation",
"hydra:mapping": [
{
"@type": "IriTemplateMapping",
"variable": "order[id]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTs[before]",
"property": "createdTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTs[strictly_before]",
"property": "createdTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTs[after]",
"property": "createdTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTs[strictly_after]",
"property": "createdTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[before]",
"property": "updatedTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[strictly_before]",
"property": "updatedTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[after]",
"property": "updatedTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[strictly_after]",
"property": "updatedTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[id]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[channel.id]",
"property": "channel.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[score]",
"property": "score",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[advertiserPayout]",
"property": "advertiserPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[email]",
"property": "email",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "exists[leadFlag]",
"property": "leadFlag",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "exists[publisher]",
"property": "publisher",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayout[between]",
"property": "advertiserPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayout[gt]",
"property": "advertiserPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayout[gte]",
"property": "advertiserPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayout[lt]",
"property": "advertiserPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayout[lte]",
"property": "advertiserPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherPayout[between]",
"property": "publisherPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherPayout[gt]",
"property": "publisherPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherPayout[gte]",
"property": "publisherPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherPayout[lt]",
"property": "publisherPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherPayout[lte]",
"property": "publisherPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserBillable",
"property": "advertiserBillable",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherBillable",
"property": "publisherBillable",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "id",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "id[]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "integration",
"property": "integration",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "integration[]",
"property": "integration",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisher.name",
"property": "publisher.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaign.id",
"property": "campaign.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaign.id[]",
"property": "campaign.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaign.name",
"property": "campaign.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignLink.channel.name",
"property": "campaignLink.channel.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignLink.channel.name[]",
"property": "campaignLink.channel.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "processrStatus",
"property": "processrStatus",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "processrStatus[]",
"property": "processrStatus",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadFlag.id",
"property": "leadFlag.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadFlag.id[]",
"property": "leadFlag.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "qaResult.id",
"property": "qaResult.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "qaResult.id[]",
"property": "qaResult.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadStatus.id",
"property": "leadStatus.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadStatus.id[]",
"property": "leadStatus.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignForm.id",
"property": "campaignForm.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignForm.id[]",
"property": "campaignForm.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignForm.name",
"property": "campaignForm.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignForm.slug",
"property": "campaignForm.slug",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaign.advertiser.id",
"property": "campaign.advertiser.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaign.advertiser.id[]",
"property": "campaign.advertiser.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaign.advertiser.name",
"property": "campaign.advertiser.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "postcode",
"property": "postcode",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "addressLine1",
"property": "addressLine1",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "addressLine2",
"property": "addressLine2",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "addressLine3",
"property": "addressLine3",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "addressLine4",
"property": "addressLine4",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "title",
"property": "title",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "firstName",
"property": "firstName",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "lastName",
"property": "lastName",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "telephone",
"property": "telephone",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "sex",
"property": "sex",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "photo",
"property": "photo",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadContactHistoryCurrentStatus",
"property": "leadContactHistoryCurrentStatus",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadContactHistoryCallNumber",
"property": "leadContactHistoryCallNumber",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadData.name",
"property": "leadData.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadData.type",
"property": "leadData.type",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadData.source",
"property": "leadData.source",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadData.depth",
"property": "leadData.depth",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadData.value",
"property": "leadData.value",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadDataName[]",
"property": "leadDataName[]",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignProcessrJobsPassed",
"property": "campaignProcessrJobsPassed[]",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "processrJobsPassed",
"property": "processrJobsPassed[]",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignProcessrJobsFailed",
"property": "campaignProcessrJobsFailed[]",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "processrJobsFailed",
"property": "processrJobsFailed[]",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "firstDeliveredTs[before]",
"property": "firstDeliveredTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "firstDeliveredTs[strictly_before]",
"property": "firstDeliveredTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "firstDeliveredTs[after]",
"property": "firstDeliveredTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "firstDeliveredTs[strictly_after]",
"property": "firstDeliveredTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "currentLeadFlagHistory.leadFlagReason.id",
"property": "currentLeadFlagHistory.leadFlagReason.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "currentLeadFlagHistory.leadFlagReason.id[]",
"property": "currentLeadFlagHistory.leadFlagReason.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "email",
"property": "email",
"required": false
}
]
}
}Sample response (error, 401): the server returns the response body below:
{
"message": "An authentication exception occurred."
}Get Campaign by ID
GET https://{{enterprise}}.cvtr.io/api/v4/campaigns/{{campaignId}}
Path parameters (placeholders, replace with your values):
| Placeholder | Description |
|---|---|
{{campaignId}} |
Replace with the campaignId value. |
Responses:
| Status | Meaning |
|---|---|
200 |
Returns a single campaign object. |
401 |
Access token is invalid. |
404 |
The ID is not valid / the record was not found. |
Sample request:
curl --location 'https://{{enterprise}}.cvtr.io/api/v4/campaigns/{{campaignId}}' \
--header 'Authorization: Bearer {{accessToken}}'Sample response (success, 200): sensitive values have been masked with placeholders:
{
"@context": "/api/v4/contexts/Campaign",
"@id": "/api/v4/campaigns/44400",
"@type": "Campaign",
"id": 44400,
"name": "Test",
"startTs": "2026-02-04T00:00:00+00:00",
"endTs": "2026-12-31T23:59:59+00:00",
"endTsExtension": null,
"exposePublisher": false,
"exposePublisherSub": false,
"updatedTs": "2026-07-27T15:35:02+01:00",
"defaultThresholdScore": 70,
"manualScore": false,
"combinedJobScore": 20,
"integrate": true,
"pauseTs": null,
"pauseReason": null,
"callCentre": false,
"welcomeEmail": false,
"autoSignPublisher": false,
"excludeFromAiInsights": false,
"sendMediakit": true,
"doubleOptin": false,
"scoreBaseRouting": false,
"valueBasedRouting": true,
"holdPublisherOverDelivery": false,
"acceptLinkedInLeadsIfInactive": true,
"defaultSaleValue": "0.01",
"defaultSaleCurrency": "GBP",
"useValueTransforms": true,
"sendVoucher": false,
"testMode": false,
"uncapped": false,
"leadsRequired": 100,
"baseCurrencyPayoutAmount": "1.00",
"payoutAmount": "1.00",
"payout": "CPL",
"currency": {
"@id": "/api/v4/currencies/1",
"@type": "Currency",
"id": 1,
"name": "GBP",
"symbol": "£",
"base": true,
"rateToBase": "1.0000"
},
"conversionRate": "1.0000",
"advertiser": {
"@id": "/api/v4/advertisers/22041",
"@type": "Advertiser",
"id": 22041,
"name": "Example Advertiser 1"
},
"campaignManager": null,
"accountManager": null,
"subcategory": {
"@id": "/api/v4/subcategories/3",
"@type": "Subcategory",
"id": 3,
"name": "Test"
},
"performanceModel": "full",
"baseCurrencyContractValue": "100.00",
"contractValue": "100.00",
"campaignMarket": "b2b",
"internalOnly": false,
"variablePublisherPayout": true,
"campaignType": {
"@id": "/api/v4/campaign-types/1",
"@type": "CampaignType",
"id": 1,
"name": "Cleansing & Validation",
"description": "CRM cleanup, enrichment, dedupe, compliance, hygiene projects"
},
"defaultPublisherRate": 100,
"publisherPayoutType": "CPL",
"publisherTerms": "<p>Example publisher default contract terms.</p>",
"country": null,
"unavailableCampaignLogic": "allow_leads",
"unavailableCampaignRedirectUrl": null,
"useScheduledDeliveryV2": false,
"leadProcessDelay": 0,
"facebookOfflineEventSetId": "<facebook_event_set_id>",
"facebookSystemUserAccessToken": "<facebook_access_token>",
"apiKey": "<api_key>",
"notes": null,
"signName": "Example Signer",
"signRole": "AUTO SIGNED",
"signTs": "2024-05-20T16:15:11+01:00",
"signIoNumber": null,
"signHash": "<sign_hash>",
"terms": "Example advertiser default contract terms.",
"statistics": {
"totalLeads": 27,
"invalidLeads": 11,
"cautionLeads": 0,
"validLeads": 16,
"billableLeads": 11,
"deliveredLeads": 11,
"heldLeads": 0,
"pendingBatch": 0,
"processingLeads": 0,
"impressions": 0,
"conversions": 8,
"lastConversion": "2026-04-21T10:33:26+01:00",
"clicks": 14,
"activePublishers": 2,
"totalSales": 0,
"campaignRevenue": {
"baseCurrencyRevenue": "11.00",
"publisherPayout": "0.00",
"baseCurrencyPublisherPayout": "0.00",
"revenueRemaining": "89.00",
"revenue": "11.00"
},
"unsignedContracts": 0
},
"status": "Active",
"allowPublisherImportExport": true,
"allowBulkEdit": true,
"purchaseOrder": null,
"purchaseOrderFile": null,
"referenceNumber": null,
"shareScheduledDeliveryWithPublishers": false,
"defaultInvalidateWebhookReason": null,
"staleLeadThresholdDays": null,
"campaignDatas": [
{
"@id": "/api/v4/campaign-datas/3",
"@type": "CampaignData",
"id": 3,
"value": "Example Metadata Field",
"campaignDataField": {
"@id": "/api/v4/campaign-data-fields/1",
"@type": "CampaignDataField",
"id": 1,
"name": "new field 1",
"required": false
},
"visible": true,
"createdTs": "2026-07-27T15:35:02+01:00"
}
],
"hasUncommunicatedChangesSinceTs": "2026-02-03T10:14:04+00:00",
"isTemplate": false,
"jobsToReview": 0,
"convertrConnectConfig": {
"@id": "/api/v4/campaign-convertr-connect-configs/4",
"@type": "CampaignConvertrConnectConfig",
"id": 4,
"campaign": "/api/v4/campaigns/44400",
"credentials": {
"@id": "/api/v4/connected-app-accounts/32",
"@type": "ConnectedAppAccount",
"id": 32,
"clientId": null,
"apiUrl": "example",
"metadata": [],
"name": "Example Connected App",
"updatedTs": "2026-07-06T10:26:20+01:00"
},
"targetPublisherId": 0,
"targetCampaignId": 0,
"targetLinkId": null,
"targetFormId": 0,
"mapping": {
"form[email]": "email",
"form[country]": "country",
"form[lastName]": "lastName",
"form[firstName]": "firstName",
"form[telephone]": "telephone",
"form[company_name]": "",
"form[number_of_employees]": "employee_size",
"form[how_awesome_is_this_campaign]": ""
}
}
}Sample response (error, 401): the server returns the response body below:
{
"message": "An authentication exception occurred."
}Sample response (error, 404): the server returns the response body below:
{
"@context": "/api/v4/contexts/Error",
"@type": "hydra:Error",
"hydra:title": "An error occurred",
"hydra:description": "Not Found"
}Get Lead by ID
GET https://{{enterprise}}.cvtr.io/api/v4/leads/{{leadId}}
Path parameters (placeholders, replace with your values):
| Placeholder | Description |
|---|---|
{{leadId}} |
Replace with the leadId value. |
Responses:
| Status | Meaning |
|---|---|
200 |
Returns a single lead object. |
401 |
Access token is invalid. |
404 |
The ID is not valid / the record was not found. |
Sample request:
curl --location 'https://{{enterprise}}.cvtr.io/api/v4/leads/{{leadId}}' \
--header 'Authorization: Bearer {{accessToken}}'Sample response (success, 200): sensitive values have been masked with placeholders:
{
"@context": "/api/v4/contexts/Lead",
"@id": "/api/v4/leads/45266",
"@type": "Lead",
"id": 45266,
"publisherSubId": "",
"channel": {
"@id": "/api/v4/channels/2",
"@type": "Channel",
"name": "Text Link"
},
"formHash": null,
"createdTs": "2026-04-21T10:33:25+01:00",
"postcode": "",
"addressLine1": "",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"title": "",
"firstName": "Example",
"lastName": "Lead",
"email": "example.lead@example.com",
"telephone": "",
"dob": null,
"sex": "",
"photo": "",
"ip": "203.0.113.10, 198.51.100.20",
"host": null,
"optIn": true,
"doubleOptIn": false,
"integration": true,
"overAllocation": "",
"visible": true,
"processrStatus": 1000,
"score": 20,
"hardfail": false,
"maxScore": 20,
"processingCounter": 3,
"suppressionList": false,
"imported": false,
"firstDeliveredTs": "2026-04-21T10:36:40+01:00",
"firstIntegrationTs": "2026-04-21T10:35:09+01:00",
"emailHash": null,
"fingerprint": null,
"baseCurrencyPublisherPayout": "0.00",
"publisherPayout": "0.00",
"baseCurrencyAdvertiserPayout": "1.00",
"advertiserPayout": "1.00",
"publisherBillable": false,
"advertiserBillable": true,
"saleValue": null,
"updatedTs": "2026-04-22T08:00:04+01:00",
"campaingSales": [],
"campaign": {
"@id": "/api/v4/campaigns/44400",
"@type": "Campaign",
"id": 44400,
"name": "Test Campaign",
"advertiser": {
"@id": "/api/v4/advertisers/22041",
"@type": "Advertiser",
"id": 22041,
"name": "Example Advertiser"
}
},
"campaignForm": null,
"globalForm": {
"@id": "/api/v4/forms/8147",
"@type": "Form",
"id": 8147,
"name": "Training Form",
"slug": "training-form"
},
"publisher": {
"@id": "/api/v4/publishers/11251",
"@type": "Publisher",
"id": 11251,
"name": "Example Publisher"
},
"campaignLink": {
"@id": "/api/v4/campaign-links/10222",
"@type": "CampaignLink",
"channel": {
"@id": "/api/v4/channels/2",
"@type": "Channel",
"name": "Text Link"
}
},
"trackClick": "/api/v4/track-clicks/184",
"qaResult": {
"@id": "/api/v4/lead-qa-results/1",
"@type": "LeadQaResult",
"name": "Valid"
},
"leadStatus": {
"@id": "/api/v4/lead-statuses/1",
"@type": "LeadStatus",
"name": "Valid"
},
"campaignPublisherBand": {
"@id": "/api/v4/campaign-publisher-bands/1846",
"@type": "CampaignPublisherBand",
"campaignPayoutBand": null
},
"advertiserIO": null,
"whitepaper": null,
"entryPoint": "form",
"landingPageUrl": null,
"failedJobCount": 0,
"leadContactHistory": [],
"leadHash": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"leadMetadataReason": null,
"leadFlag": null,
"leadData": [
{
"@id": "/api/v4/lead-datas/1311405",
"@type": "LeadData",
"type": "core.data",
"name": "emailDomain",
"value": "@example.com",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1311406",
"@type": "LeadData",
"type": "core.data",
"name": "createdDate",
"value": "2026-04-21",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1311407",
"@type": "LeadData",
"type": "core.data",
"name": "createdYear",
"value": "2026",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1311408",
"@type": "LeadData",
"type": "core.data",
"name": "createdMonth",
"value": "Apr",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1311409",
"@type": "LeadData",
"type": "core.data",
"name": "country",
"value": "US",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1311410",
"@type": "LeadData",
"type": "core.data",
"name": "asset",
"value": "example-asset",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1311411",
"@type": "LeadData",
"type": "core.data",
"name": "utm_campaign",
"value": "",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1311412",
"@type": "LeadData",
"type": "core.data",
"name": "leadHash",
"value": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1311435",
"@type": "LeadData",
"type": "core.data",
"name": "serviceprovider",
"value": "2026-04-21 10:33:25|Example Provider",
"source": "Value Transform"
},
{
"@id": "/api/v4/lead-datas/1311436",
"@type": "LeadData",
"type": "core.data",
"name": "time",
"value": "2026-04-21 10:33:25",
"source": "Value Transform"
},
{
"@id": "/api/v4/lead-datas/1311437",
"@type": "LeadData",
"type": "core.data",
"name": "email_hashed",
"value": "<email_hash>",
"source": "Value Transform"
}
],
"integrationResults": [
{
"@id": "/api/v4/processr-job-leads/146784",
"@type": "ProcessrJobLead",
"id": 146784,
"passed": true,
"createdTs": "2026-04-21 10:36:40",
"executedTs": "2026-04-21 12:00:03",
"alwaysDeliver": false
},
{
"@id": "/api/v4/processr-job-leads/146785",
"@type": "ProcessrJobLead",
"id": 146785,
"passed": true,
"createdTs": "2026-04-21 10:36:40",
"executedTs": "2026-04-21 10:36:40",
"alwaysDeliver": false
},
{
"@id": "/api/v4/processr-job-leads/146786",
"@type": "ProcessrJobLead",
"id": 146786,
"passed": true,
"createdTs": "2026-04-21 10:36:40",
"executedTs": "2026-04-22 08:00:04",
"alwaysDeliver": false
}
]
}Sample response (error, 401): the server returns the response body below:
{
"message": "An authentication exception occurred."
}Sample response (error, 404): the server returns the response body below:
{
"@context": "/api/v4/contexts/Error",
"@type": "hydra:Error",
"hydra:title": "An error occurred",
"hydra:description": "Not Found"
}Flag lead as invalid
POST https://{{enterprise}}.cvtr.io/api/webhook/invalidate/{{leadHash}}
Generated from cURL: curl --location 'https://{client}.cvtr.io/api/webhook/invalidate/{leadHash}' \ --form 'reason="Unable to Contact"' \ --form 'user="John Smith"'
Authentication: none required.
Path parameters (placeholders, replace with your values):
| Placeholder | Description |
|---|---|
{{leadHash}} |
Replace with the leadHash value. |
Body (form-data) values shown are placeholders, replace with your own:
| Key | Value |
|---|---|
reason |
You can include here the reason that the lead is being invalidated. |
user |
Use this as an identifer for who is updating the lead's status |
Responses:
| Status | Meaning |
|---|---|
201 |
Success. No response body. |
404 |
Lead not found. The leadHash is not valid. |
Sample request:
curl --location 'https://{{enterprise}}.cvtr.io/api/webhook/invalidate/{{leadHash}}' \
--form 'reason="Unable to Contact"' \
--form 'user="John Smith"'Sample response (success):
HTTP/1.1 201 Created (no response body)
Sample response (error, 404): the server returns an HTML error page:
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<meta name="robots" content="noindex, nofollow">
<title>
An Error Occurred: Not Found
</title>
<link rel="stylesheet" type="text/css" charset="UTF-8" media="all" href="/bundles/convertruser/css/fonts.css" />
<link rel="stylesheet" type="text/css" charset="UTF-8" media="all" href="/bundles/convertruser/css/login.css" />
</head>
<body class="convertr">
<div class="main">
<div class="wrapper">
<div class="container-outer-big">
<div class="container">
<div class="logo">
<div class="error-icon">
!
</div>
</div>
<div class="content">
<div class="padding">
<div class="error-message">
<div class="error-title">
Error!
</div>
<div class="error-subtitle">
The server returned a "404 Not Found".
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
Flag lead as valid
POST https://{{enterprise}}.cvtr.io/api/webhook/validate/{{leadHash}}
Authentication: none required.
Path parameters (placeholders, replace with your values):
| Placeholder | Description |
|---|---|
{{leadHash}} |
Replace with the leadHash value. |
Body (form-data) values shown are placeholders, replace with your own:
| Key | Value |
|---|---|
reason |
You can include here the reason that the lead is being invalidated. |
user |
Use this as an identifer for who is updating the lead's status |
Responses:
| Status | Meaning |
|---|---|
201 |
Success. No response body. |
404 |
Lead not found. The leadHash is not valid. |
Sample request:
curl --location 'https://{{enterprise}}.cvtr.io/api/webhook/validate/{{leadHash}}' \
--form 'reason="Verified"' \
--form 'user="John Smith"'Sample response (success):
HTTP/1.1 201 Created (no response body)
Sample response (error, 404): the server returns an HTML error page:
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<meta name="robots" content="noindex, nofollow">
<title>
An Error Occurred: Not Found
</title>
<link rel="stylesheet" type="text/css" charset="UTF-8" media="all" href="/bundles/convertruser/css/fonts.css" />
<link rel="stylesheet" type="text/css" charset="UTF-8" media="all" href="/bundles/convertruser/css/login.css" />
</head>
<body class="convertr">
<div class="main">
<div class="wrapper">
<div class="container-outer-big">
<div class="container">
<div class="logo">
<div class="error-icon">
!
</div>
</div>
<div class="content">
<div class="padding">
<div class="error-message">
<div class="error-title">
Error!
</div>
<div class="error-subtitle">
The server returned a "404 Not Found".
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
Append/Edit Data to Lead
POST https://{{enterprise}}.cvtr.io/ajax/lead-append/{{leadHash}}
Authentication: none required.
Path parameters (placeholders, replace with your values):
| Placeholder | Description |
|---|---|
{{leadHash}} |
Replace with the leadHash value. |
Body (x-www-form-urlencoded) values shown are placeholders, replace with your own:
| Key | Value |
|---|---|
{{fieldName}} |
{{fieldValue}} |
Here both the key and the value are placeholders. Send the actual field name as the key and its value as the value; for example, a key of phone with a value of 07123456789.
Behaviour: If the field being written already exists on the lead, it is edited (overwritten). If it does not exist, a new field is created.
Responses:
| Status | Meaning |
|---|---|
204 |
Success. No response body. |
404 |
Lead not found. The leadHash is not valid. |
Sample request:
curl --location 'https://{{enterprise}}.cvtr.io/ajax/lead-append/{{leadHash}}' \
--data-urlencode 'phone=07123456789'Sample response (success):
HTTP/1.1 204 No Content (no response body)
Sample response (error, 404): the server returns an HTML error page:
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<meta name="robots" content="noindex, nofollow">
<title>
An Error Occurred: Not Found
</title>
<link rel="stylesheet" type="text/css" charset="UTF-8" media="all" href="/bundles/convertruser/css/fonts.css" />
<link rel="stylesheet" type="text/css" charset="UTF-8" media="all" href="/bundles/convertruser/css/login.css" />
</head>
<body class="convertr">
<div class="main">
<div class="wrapper">
<div class="container-outer-big">
<div class="container">
<div class="logo">
<div class="error-icon">
!
</div>
</div>
<div class="content">
<div class="padding">
<div class="error-message">
<div class="error-title">
Error!
</div>
<div class="error-subtitle">
The server returned a "404 Not Found".
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>