Skip to main content

Get the jobs.

GET 
/api/v4/jobs

Get a page of jobs. Use the query parameters to modify the behaviour of this endpoint.

Minimum server version: 4.1

Permissions​

Must have permission to read at least one job type returned by this call. When no job_type query parameter is set, the server only includes job types your session may read; required permission depends on the job type:

  • read_data_retention_job — data_retention
  • read_compliance_export_job — message_export
  • read_elasticsearch_post_indexing_job — elasticsearch_post_indexing
  • read_elasticsearch_post_aggregation_job — elasticsearch_post_aggregation
  • read_ldap_sync_job — ldap_sync
  • read_jobs — migrations, plugins, product_notices, expiry_notify, active_users, import_process, import_delete, export_process, export_delete, cloud, mobile_session_metadata, extract_content
  • manage_system — access_control_sync

When job_type is set, you must have the permission that matches that type (same mapping as above).

This endpoint does not accept team_id. To list access_control_sync jobs scoped to a team without manage_system, use GET /api/v4/jobs/type/access_control_sync with query parameter team_id set to the team GUID (requires manage_team_access_rules on that team).

Request​

Responses​

Job list retrieval successful