Get background processes

GET

https://api.brevo.com/v3/processes

GET

/v3/processes

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.process.getProcesses({});
}
main();

{
  "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"
    }
  ]
}

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

Authentication

api-keystring

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

AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Query parameters

limitlongOptional1-50Defaults to 10

Number limitation for the result returned

offsetlongOptionalDefaults to 0

Beginning point in the list to retrieve from.

sortenumOptionalDefaults to desc

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Allowed values:

Response

Background processes retrieved successfully

countlong

Total number of processes available on your account

processeslist of objects

List of background processes on your account

Errors

400

Bad Request Error