--- updatedAt: 2026-05-14T14:36:14.000Z agentTools: projectIndex: https://docs.talkdesk.com/llms.txt --- # Get Campaign Details Returns the details of a specific campaign. Use this endpoint to retrieve full campaign configuration including dialing mode and strategy. Specify the campaign ID in the path. # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "title": "Public API", "version": "5.12.68", "description": "Documents public API endpoints. Scopes are given to external software, that we don't control", "contact": { "name": "Talkdesk", "url": "https://talkdesk.com" } }, "servers": [ { "url": "https://api.talkdeskapp.com", "description": "United States (td-us-1)" }, { "url": "https://api.talkdeskapp.eu", "description": "Europe (td-eu-1)" }, { "url": "https://api.talkdeskappca.com", "description": "Canada (td-ca-1)" }, { "url": "https://api.talkdeskapp.co.uk", "description": "United Kingdom (td-uk-1)" } ], "tags": [ { "name": "Campaign Management API", "description": "Campaign Management API" } ], "paths": { "/campaigns/{id}": { "get": { "operationId": "campaigns-id-get", "summary": "Get Campaign Details", "description": "Returns the details of a specific campaign.\nUse this endpoint to retrieve full campaign configuration including dialing mode and strategy.\nSpecify the campaign ID in the path.\n", "x-namespace": "/campaigns", "tags": [ "Campaign Management API" ], "x-internal": false, "parameters": [ { "name": "id", "in": "path", "description": "Id of the campaign to return", "required": true, "schema": { "type": "string", "maxLength": 26 } }, { "name": "fields", "in": "query", "description": "Allows to request the sub entities of the campaign

", "required": false, "schema": { "type": "string", "maxLength": 2083 } } ], "responses": { "200": { "description": "Campaign returned successfully", "content": { "application/hal+json": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "maxLength": 36 }, "name": { "type": "string", "minLength": 3, "maxLength": 35 }, "dialing_mode": { "type": "string", "maxLength": 35, "enum": [ "PREDICTIVE", "PREVIEW" ] }, "priority": { "type": "integer", "minimum": 1, "maximum": 10 }, "run_once": { "type": "boolean" }, "action_required": { "type": "boolean" }, "status": { "type": "string", "maxLength": 35, "enum": [ "INCOMPLETE", "READY", "RUNNING", "PAUSED" ] }, "dialing_mode_configuration": { "type": "object", "required": [ "max_ring_time_in_secs" ], "properties": { "answering_machine_detection": { "type": "boolean", "description": "The flag to decide if disconnects calls that reach answering machines or voicemails. Only to be used in Predictive mode." }, "amd_metadata": { "type": "boolean", "description": "The flag to decide if an additional in-house AMD layer based on Metadata that will improve the initial AMD decision in Dialer. Only to be used in Predictive mode." }, "max_abandonment_rate": { "type": "integer", "description": "Maximum rate of abandoned calls. Only to be used in Predictive mode.", "minimum": 1, "maximum": 100 }, "max_dialing_ratio": { "type": "integer", "description": "Maximum number of calls launched per agent. Only to be used in Predictive mode.", "minimum": 1, "maximum": 3 }, "max_ring_time_in_secs": { "type": "integer", "description": "The time in which if the calls are not answered they are disconnected", "minimum": 6, "maximum": 120 }, "abandonment_timeout": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "type": "integer", "description": "The time in which automatically hangs up answered calls that haven't been connected to an agent. Unit in seconds. Only to be used in Predictive mode.", "minimum": 2, "maximum": 30 } } } } }, "dialing_strategy": { "type": "object", "required": [ "max_attempts", "retry_period", "retry_time_unit", "calling_hours", "dispositions" ], "properties": { "max_skip_attempts": { "type": "integer", "description": "The maximum number of times that an agent can skip a call.", "minimum": 0, "maximum": 20 }, "strategy_type": { "type": "string", "maxLength": 35, "description": "The strategy on how the records will be dialed.", "enum": [ "AUTOMATIC", "MANUAL" ] }, "preview_timeout": { "type": "integer", "description": "The time in seconds that the preview context will be available to the agent.", "minimum": 6, "maximum": 300 }, "max_attempts": { "type": "integer", "description": "The maximum number of non-final call attempts each record may receive.", "minimum": 1, "maximum": 100 }, "retry_period": { "type": "integer", "description": "Time between non-final call attempts.", "minimum": 1, "maximum": 2592000 }, "retry_time_unit": { "type": "string", "maxLength": 35, "description": "The time unit for the retry_period", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ] }, "calling_hours": { "type": "array", "description": "Set of rules to be applied based on location of the records lists.", "items": { "type": "object", "required": [ "from", "to", "week_days" ], "properties": { "from": { "type": "string", "maxLength": 8, "format": "time", "description": "start time format hh:MM:ss" }, "to": { "type": "string", "maxLength": 8, "format": "time", "description": "end time format hh:MM:ss" }, "week_days": { "type": "array", "items": { "type": "string", "maxLength": 35, "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } } } } }, "dispositions": { "type": "object", "description": "System Dispositions to be available for defined campaign", "required": [ "busy", "no_answer", "invalid_number" ], "properties": { "busy": { "type": "object", "description": "busy disposition settings", "required": [ "status_after_call", "custom" ], "properties": { "status_after_call": { "type": "string", "maxLength": 35, "enum": [ "FINAL", "RETRY" ] }, "custom": { "type": "boolean" }, "max_attempts": { "type": "integer", "minimum": 1, "maximum": 100 }, "retry_period": { "type": "integer", "minimum": 1, "maximum": 2592000 }, "retry_period_time_unit": { "type": "string", "maxLength": 35, "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "no_answer": { "type": "object", "description": "no_answer disposition settings", "required": [ "status_after_call", "custom" ], "properties": { "status_after_call": { "type": "string", "maxLength": 35, "enum": [ "FINAL", "RETRY" ] }, "custom": { "type": "boolean" }, "max_attempts": { "type": "integer", "minimum": 1, "maximum": 100 }, "retry_period": { "type": "integer", "minimum": 1, "maximum": 2592000 }, "retry_period_time_unit": { "type": "string", "maxLength": 35, "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "abandoned": { "type": "object", "description": "abandonment disposition settings", "required": [ "status_after_call", "custom" ], "properties": { "status_after_call": { "type": "string", "maxLength": 35, "enum": [ "FINAL", "RETRY" ] }, "custom": { "type": "boolean" }, "max_attempts": { "type": "integer", "minimum": 1, "maximum": 100 }, "retry_period": { "type": "integer", "minimum": 1, "maximum": 2592000 }, "retry_period_time_unit": { "type": "string", "maxLength": 35, "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "hangup_before_connection": { "type": "object", "description": "hangup_before_connection disposition settings", "required": [ "status_after_call", "custom" ], "properties": { "status_after_call": { "type": "string", "maxLength": 35, "enum": [ "FINAL", "RETRY" ] }, "custom": { "type": "boolean" }, "max_attempts": { "type": "integer", "minimum": 1, "maximum": 100 }, "retry_period": { "type": "integer", "minimum": 1, "maximum": 2592000 }, "retry_period_time_unit": { "type": "string", "maxLength": 35, "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "agent_hangup_before_connection": { "type": "object", "description": "agent_hangup_before_connection disposition settings", "required": [ "status_after_call", "custom" ], "properties": { "status_after_call": { "type": "string", "maxLength": 35, "enum": [ "FINAL", "RETRY" ] }, "custom": { "type": "boolean" }, "max_attempts": { "type": "integer", "minimum": 1, "maximum": 100 }, "retry_period": { "type": "integer", "minimum": 1, "maximum": 2592000 }, "retry_period_time_unit": { "type": "string", "maxLength": 35, "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "answering_machine_detection": { "type": "object", "description": "answering_machine_detection disposition settings", "required": [ "status_after_call", "custom" ], "properties": { "status_after_call": { "type": "string", "maxLength": 35, "enum": [ "FINAL", "RETRY" ] }, "custom": { "type": "boolean" }, "max_attempts": { "type": "integer", "minimum": 1, "maximum": 100 }, "retry_period": { "type": "integer", "minimum": 1, "maximum": 2592000 }, "retry_period_time_unit": { "type": "string", "maxLength": 35, "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "invalid_number": { "description": "invalid number disposition setting", "type": "object", "required": [ "status_after_call" ], "properties": { "status_after_call": { "type": "string", "maxLength": 35, "enum": [ "FINAL" ] } } } } }, "record_chain": { "type": "array", "description": "Set of rules to be applied based on the phone type. Must have exactly one of each phone type (see type enum).", "items": { "description": "Record chaining settings for each phone type.", "type": "object", "required": [ "type", "max_attempts" ], "properties": { "type": { "type": "string", "description": "Phone Type.", "enum": [ "HOME", "OFFICE", "MOBILE", "EXTRA_1", "EXTRA_2", "EXTRA_3" ] }, "max_attempts": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Number of attempts" }, "retry_period": { "type": "integer", "minimum": 1, "maximum": 2592000, "description": "Time between call attempts for phones of this type." }, "retry_time_unit": { "type": "string", "description": "The time unit for the retry_period.", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } } }, "lists_sorting_criteria": { "type": "string", "maxLength": 10, "description": "The config on how the records will be sorted", "enum": [ "FIFO", "LIFO" ] } } }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "name" ] } ], "properties": { "_links": { "type": "object", "description": "HAL API related links.", "properties": { "self": { "type": "object", "description": "Link to fetch the detail of the Campaign", "properties": { "href": { "type": "string", "maxLength": 2083, "description": "Address of the resource" } }, "required": [ "href" ] }, "campaigns": { "type": "object", "description": "Link to fetch a list of all the campaigns", "properties": { "href": { "type": "string", "maxLength": 2083, "description": "Address of the resources" } }, "required": [ "href" ] } }, "required": [ "self", "campaigns" ] } }, "required": [ "id", "_links" ] }, "example": { "id": "123e4567-e89b-12d3-a456-426655440000", "name": "50% discount on culinary courses", "dialing_mode": "PREDICTIVE", "priority": 5, "run_once": true, "action_required": false, "status": "READY", "dialing_mode_configuration": { "answering_machine_detection": false, "amd_metadata": false, "max_abandonment_rate": 2, "max_dialing_ratio": 3, "max_ring_time_in_secs": 6, "abandonment_timeout": { "amount": 14 } }, "dialing_strategy": { "max_skip_attempts": 4, "strategy_type": "AUTOMATIC", "preview_timeout": 100, "max_attempts": 99, "retry_period": 100, "retry_time_unit": "SECONDS", "calling_hours": [ { "from": "01:00:00", "to": "02:00:00", "week_days": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } ], "dispositions": { "busy": { "status_after_call": "RETRY", "custom": false, "max_attempts": 45, "retry_period": 123, "retry_period_time_unit": "SECONDS" }, "no_answer": { "status_after_call": "RETRY", "custom": false, "max_attempts": 45, "retry_period": 123, "retry_period_time_unit": "SECONDS" }, "abandoned": { "status_after_call": "RETRY", "custom": false, "max_attempts": 45, "retry_period": 123, "retry_period_time_unit": "SECONDS" }, "hangup_before_connection": { "status_after_call": "RETRY", "custom": false, "max_attempts": 45, "retry_period": 123, "retry_period_time_unit": "SECONDS" }, "agent_hangup_before_connection": { "status_after_call": "RETRY", "custom": false, "max_attempts": 45, "retry_period": 123, "retry_period_time_unit": "SECONDS" }, "answering_machine_detection": { "status_after_call": "RETRY", "custom": false, "max_attempts": 45, "retry_period": 123, "retry_period_time_unit": "SECONDS" }, "invalid_number": { "status_after_call": "FINAL" } }, "record_chain": [ { "type": "HOME", "max_attempts": 5, "retry_period": 300, "retry_period_time_unit": "MINUTES" }, { "type": "OFFICE", "max_attempts": 3, "retry_period": 123, "retry_period_time_unit": "SECONDS" }, { "type": "MOBILE", "max_attempts": 2, "retry_period": 213, "retry_period_time_unit": "SECONDS" }, { "type": "EXTRA_1", "max_attempts": 2, "retry_period": 213, "retry_period_time_unit": "SECONDS" }, { "type": "EXTRA_2", "max_attempts": 2, "retry_period": 213, "retry_period_time_unit": "SECONDS" }, { "type": "EXTRA_3", "max_attempts": 2, "retry_period": 213, "retry_period_time_unit": "SECONDS" } ], "ivr_enabled": true, "lists_sorting_criteria": "FIFO" }, "_links": { "self": { "href": "http://api-docs.talkdesk.org/campaigns/123e4567-e89b-12d3-a456-426655440000" }, "campaigns": { "href": "http://api-docs.talkdesk.org/campaigns" } } } } } }, "400": { "description": "Errors were found in the submitted data.", "content": { "application/hal+json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "example": { "code": "0530001", "message": "Errors were found in the submitted data" } } } }, "401": { "description": "Unauthorized", "content": { "application/hal+json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "example": { "code": "0530004", "message": "Missing or invalid authentication token" } } } }, "403": { "description": "Forbidden", "content": { "application/hal+json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "example": { "code": "0530003", "message": "Insufficient scopes for the requested operation" } } } }, "404": { "description": "Campaign not found", "content": { "application/hal+json": { "schema": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } }, "example": { "code": "0530002", "message": "The requested resource could not be found" } } } } } } } }, "externalDocs": { "description": "External Documentation", "url": "https://api-docs.talkdeskapp.com/external_docs" } } ```