For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Introduction
    • Getting started
  • Email API
  • Transactional SMS
  • Transactional WhatsApp
  • Marketing Campaigns
  • Contact Management
  • Events
    • GETGet events
    • POSTCreate an event
    • POSTCreate events in batch
  • Object Management
  • Accounts and Settings
      • GETGet background processes
      • GETGet process details
  • Sales CRM
  • Conversations
  • Ecommerce
  • Loyalty
LogoLogo
Help CenterAPI KeysStatusSign In
Accounts and SettingsProcess

Get process details

GET
https://api.brevo.com/v3/processes/:processId
GET
/v3/processes/:processId
1import { BrevoClient } from "@getbrevo/brevo";
2
3async function main() {
4    const client = new BrevoClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.process.getProcess(1);
8}
9main();
1{
2  "id": 217,
3  "name": "IMPORTUSER",
4  "status": "queued"
5}
Retrieves detailed information about a specific background process. **Use this to:** - Get detailed status of a specific process - Monitor process progress and completion - Download results from completed export processes - Check error details for failed processes - Track process execution times **Key information returned:** - Complete process details (ID, name, status) - Download URLs for completed export processes - Import details with CSV report URLs for completed import processes **Important considerations:** - Process ID must exist in your account and not be deleted - Completed export processes include download URLs - Completed import processes include CSV report URLs with details about problematic records - Different process types return different result structures
Was this page helpful?
Previous

Get all external feeds

Next
Built with

Retrieves detailed information about a specific background process.

Use this to:

  • Get detailed status of a specific process
  • Monitor process progress and completion
  • Download results from completed export processes
  • Check error details for failed processes
  • Track process execution times

Key information returned:

  • Complete process details (ID, name, status)
  • Download URLs for completed export processes
  • Import details with CSV report URLs for completed import processes

Important considerations:

  • Process ID must exist in your account and not be deleted
  • Completed export processes include download URLs
  • Completed import processes include CSV report URLs with details about problematic records
  • Different process types return different result structures

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

processIdlongRequired
Id of the process

Response

Process information retrieved successfully
idlong
Unique identifier of the process
nameenum

Name/type of the process

statusenum
Current status of the process
infoobject
Additional process information, only returned for completed IMPORTUSER processes. Contains URLs to CSV files with details about problematic records.
export_urlstringformat: "url"

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
404
Not Found Error