> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.brevo.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.brevo.com/_mcp/server. # Get background processes GET https://api.brevo.com/v3/processes Retrieves a list of background processes from your Brevo account with filtering and pagination. **Use this to:** - Monitor background process activity and status - Track long-running operations and tasks - Find process IDs for detailed status checking - Review process history and performance - Identify failed or stuck processes for troubleshooting **Key information returned:** - Process details (ID, name, status) - Export download URLs for completed export processes - Import details with CSV report URLs for completed import processes - Total count of processes for pagination **Important considerations:** - Background processes handle long-running operations like imports and exports - Process status indicates current state (queued, processing, completed) - Export processes provide download URLs when completed - Import processes provide CSV report URLs with details about problematic records - Use pagination for accounts with many historical processes - Sort options available for creation order (ascending or descending) - Default limit is 10 results per page, maximum is 50 Reference: https://developers.brevo.com/reference/get-processes ## Authentication - `api-key` header (required) — The API key should be passed in the request headers as `api-key` for authentication. ## Request ### Query parameters - `limit` (long, optional, default: 10) — Number limitation for the result returned - `offset` (long, optional, default: 0) — Beginning point in the list to retrieve from. - `sort` (enum, optional, default: desc) — Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed - Allowed values: `asc`, `desc` ## Response ### 200 Background processes retrieved successfully - `count` (long, required) — Total number of processes available on your account - `processes` (list of object, required) — List of background processes on your account - `id` (long, required) — Unique identifier of the process - `name` (enum, required) — Name/type of the process - Allowed values: `IMPORTUSER`, `SEARCH_EXPORT_USERS`, `TRANS-CALC`, `TRANS-GLOBAL-CALC`, `CAMPAIGN_PROCESSING`, `LIST_EXPORT`, `CONTACT_EXPORT` - `status` (enum, required) — Current status of the process - Allowed values: `queued`, `in_process`, `processing`, `completed`, `failed`, `cancelled` - `info` (object, optional) — Additional process information, only returned for completed IMPORTUSER processes. Contains URLs to CSV files with details about problematic records. - `import` (object, optional) — Import process details with URLs to CSV reports - `invalid_emails` (string, optional, nullable) — URL to CSV file containing invalid email addresses, or null if none - `duplicate_contact_id` (string, optional, nullable) — URL to CSV file containing duplicate contact IDs, or null if none - `duplicate_ext_id` (string, optional, nullable) — URL to CSV file containing duplicate external IDs, or null if none - `duplicate_email_id` (string, optional, nullable) — URL to CSV file containing duplicate email IDs, or null if none - `duplicate_phone_id` (string, optional, nullable) — URL to CSV file containing duplicate phone numbers, or null if none - `duplicate_whatsapp_id` (string, optional, nullable) — URL to CSV file containing duplicate WhatsApp numbers, or null if none - `duplicate_landline_number_id` (string, optional, nullable) — URL to CSV file containing duplicate landline numbers, or null if none - `export_url` (string, optional) — Download URL for completed export processes (returned for SEARCH_EXPORT_USERS, SEARCH_EXPORT_USERS_API, CAMPAIGN_USER_DETAILS, and EXPORT_WEBHOOK process types) ## Errors ### 400 Bad Request Error bad request - `code` (enum, required) — Error code displayed in case of a failure - Allowed values: `invalid_parameter`, `missing_parameter`, `out_of_range`, `campaign_processing`, `campaign_sent`, `document_not_found`, `not_enough_credits`, `permission_denied`, `duplicate_parameter`, `duplicate_request`, `method_not_allowed`, `unauthorized`, `account_under_validation`, `not_acceptable`, `bad_request`, `unprocessable_entity`, `Domain does not exist`, `Contact email not found`, `Attribute not found`, `Category id not found`, `Invalid parameters passed`, `Record(s) for identifier not found`, `Returned when query params are invalid`, `Returned when invalid data posted`, `Feed not found`, `Campaign ID not found`, `api-key not found`, `DMARC policy requires domain authentication`, `DNS records not properly configured`, `Invalid OTP code provided`, `OTP code has expired`, `Domain already exists in your account`, `The sum of all IP weights must equal 100`, `Authentication failed`, `Insufficient credits`, `Request already processed` - `message` (string, required) — Readable message associated to the failure ## Examples **Response** ```json { "count": 198, "processes": [ { "id": 217, "name": "IMPORTUSER", "status": "completed", "info": { "import": { "invalid_emails": null, "duplicate_contact_id": null, "duplicate_ext_id": null, "duplicate_email_id": null, "duplicate_phone_id": null, "duplicate_whatsapp_id": null, "duplicate_landline_number_id": null } } }, { "id": 213, "name": "SEARCH_EXPORT_USERS", "status": "completed", "export_url": "https://s3.eu-west-1.amazonaws.com/api-export.example.com/upload/contacts_export.csv" }, { "id": 212, "name": "IMPORTUSER", "status": "queued" } ] } ``` **SDK Code** ```typescript List of background processes with various statuses import { BrevoClient } from "@getbrevo/brevo"; async function main() { const client = new BrevoClient({ apiKey: "YOUR_API_KEY_HERE", }); await client.process.getProcesses({}); } main(); ``` ```python List of background processes with various statuses from brevo import Brevo client = Brevo( api_key="YOUR_API_KEY_HERE", ) client.process.get_processes() ``` ```php List of background processes with various statuses process->getProcesses( new GetProcessesRequest([]), ); ``` ```go List of background processes with various statuses package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.brevo.com/v3/processes" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("api-key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby List of background processes with various statuses require 'uri' require 'net/http' url = URI("https://api.brevo.com/v3/processes") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["api-key"] = '' response = http.request(request) puts response.read_body ``` ```java List of background processes with various statuses import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.brevo.com/v3/processes") .header("api-key", "") .asString(); ``` ```csharp List of background processes with various statuses using RestSharp; var client = new RestClient("https://api.brevo.com/v3/processes"); var request = new RestRequest(Method.GET); request.AddHeader("api-key", ""); IRestResponse response = client.Execute(request); ``` ```swift List of background processes with various statuses import Foundation let headers = ["api-key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.brevo.com/v3/processes")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```