process
Get background 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
get/processes
Request
- Base URL: https://api.brevo.com/v3
- URL: https://api.brevo.com/v3/processes
- Auth: API key in header api-key
Query parameters
limitinteger
Number limitation for the result returned
offsetinteger
Beginning point in the list to retrieve from.
sort'asc' | 'desc'
Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed
Response
Background processes retrieved successfully
Changes
No recorded changes to this operation across all 1 revision of this API.