process

Get process details

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
get/processes/{processId}

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/processes/{processId}
  • Auth: API key in header api-key

Path parameters

processIdinteger required

Id of the process

Response

Process information retrieved successfully

idinteger required

Unique identifier of the process

name'IMPORTUSER' | 'SEARCH_EXPORT_USERS' | 'TRANS-CALC' | 'TRANS-GLOBAL-CALC' | 'CAMPAIGN_PROCESSING' | 'LIST_EXPORT' | 'CONTACT_EXPORT' required

Name/type of the process

status'queued' | 'in_process' | 'processing' | 'completed' | 'failed' | 'cancelled' required

Current status of the process

export_urlstring url

Download URL for completed export processes (returned for SEARCH_EXPORT_USERS, SEARCH_EXPORT_USERS_API, CAMPAIGN_USER_DETAILS, and EXPORT_WEBHOOK process types)

Changes

No recorded changes to this operation across all 1 revision of this API.