Salesforce Sales Cloud

Salesforce Sales Cloud Query Jobs API

Create and manage bulk query jobs for extracting large data sets

GitHub OpenAPI

Operations 5

GET /jobs/query Salesforce Sales Cloud List all query jobs #
POST /jobs/query Salesforce Sales Cloud Create a query job #
GET /jobs/query/{jobId} Salesforce Sales Cloud Get query job information #
PATCH /jobs/query/{jobId} Salesforce Sales Cloud Abort a query job #
DELETE /jobs/query/{jobId} Salesforce Sales Cloud Delete a query job #

Documentation

📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_rest.htm
📖
Authentication
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_authentication.htm
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/quickstart.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/bulk_api_2_0.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/sforce_analytics_rest_api_intro.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/intro_rest_overview.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_intro.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/quickstart.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest.htm

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/salesforce-sales-cloud/refs/heads/main/openapi/salesforce-sales-cloud-query-jobs-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://www.postman.com/salesforce-developers/workspace/salesforce-developers
🔗
ChangeLog
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/rest_rns.htm
🔗
Examples
https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_code_samples.htm
🔗
Reference
https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/intro_rest_resources.htm
🔗
Examples
https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/intro_rest_resource_examples.htm
🔗
Guide
https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_what.htm
🔗
Reference
https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_message_structure.htm
🔗
Reference
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_overview.htm
🔗
Examples
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/quickreference.htm
🔗
ChangeLog
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/intro_release_notes.htm
🔗
Reference
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_overview.htm

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/salesforce-sales-cloud-query-jobs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

salesforce-sales-cloud-query-jobs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Salesforce Sales Cloud Salesforce Bulk API 2.0 Query Jobs API
  description: Optimized API for loading, updating, or deleting large data sets asynchronously with better performance than REST API. Supports ingest (insert, update, upsert, delete) and query operations on large volumes of records using CSV data format. Designed for ETL workflows and mass data operations.
  version: 59.0.0
  termsOfService: https://www.salesforce.com/company/legal/agreements/
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Master Subscription Agreement
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v59.0
  description: Salesforce Production or Developer Edition
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce instance identifier
- url: https://{instance}.sandbox.my.salesforce.com/services/data/v59.0
  description: Salesforce Sandbox
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce sandbox instance identifier
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Query Jobs
  description: Create and manage bulk query jobs for extracting large data sets
paths:
  /jobs/query:
    get:
      operationId: listQueryJobs
      summary: Salesforce Sales Cloud List all query jobs
      description: Retrieves all query jobs in the org. Results include jobs in all states including completed, failed, and aborted jobs.
      tags:
      - Query Jobs
      parameters:
      - name: isPkChunkingEnabled
        in: query
        description: Filter by PK Chunking enabled status
        required: false
        schema:
          type: boolean
      - name: jobType
        in: query
        description: Filter by job type
        required: false
        schema:
          type: string
          enum:
          - BigObjectIngest
          - Classic
          - V2Query
      - name: queryLocator
        in: query
        description: Query locator for paginating through results
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved list of query jobs
          content:
            application/json:
              schema:
                type: object
                properties:
                  done:
                    type: boolean
                  nextRecordsUrl:
                    type: string
                  records:
                    type: array
                    items:
                      $ref: '#/components/schemas/QueryJobInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createQueryJob
      summary: Salesforce Sales Cloud Create a query job
      description: Creates a new query job to extract data from Salesforce using SOQL. The query runs asynchronously and results can be retrieved when the job completes.
      tags:
      - Query Jobs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateQueryJobRequest'
      responses:
        '200':
          description: Query job created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryJobInfo'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /jobs/query/{jobId}:
    get:
      operationId: getQueryJobInfo
      summary: Salesforce Sales Cloud Get query job information
      description: Retrieves detailed information about a query job including its current state, number of records processed, and the SOQL query.
      tags:
      - Query Jobs
      parameters:
      - $ref: '#/components/parameters/jobId'
      responses:
        '200':
          description: Successfully retrieved query job information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryJobInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: abortQueryJob
      summary: Salesforce Sales Cloud Abort a query job
      description: Aborts a query job. Only jobs that have not yet completed can be aborted.
      tags:
      - Query Jobs
      parameters:
      - $ref: '#/components/parameters/jobId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - state
              properties:
                state:
                  type: string
                  enum:
                  - Aborted
      responses:
        '200':
          description: Query job aborted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryJobInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteQueryJob
      summary: Salesforce Sales Cloud Delete a query job
      description: Deletes a query job. The job must be in a terminal state before it can be deleted.
      tags:
      - Query Jobs
      parameters:
      - $ref: '#/components/parameters/jobId'
      responses:
        '204':
          description: Query job deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    BadRequest:
      description: Invalid request parameters or malformed request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The specified job was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication failed or access token is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: array
      items:
        $ref: '#/components/schemas/ApiError'
    QueryJobInfo:
      type: object
      description: Detailed information about a query job
      properties:
        id:
          type: string
        operation:
          type: string
          enum:
          - query
          - queryAll
        object:
          type: string
        createdById:
          type: string
        createdDate:
          type: string
          format: date-time
        systemModstamp:
          type: string
          format: date-time
        state:
          type: string
          enum:
          - UploadComplete
          - InProgress
          - JobComplete
          - Aborted
          - Failed
        concurrencyMode:
          type: string
        contentType:
          type: string
        apiVersion:
          type: number
        jobType:
          type: string
        lineEnding:
          type: string
        columnDelimiter:
          type: string
        numberRecordsProcessed:
          type: integer
        retries:
          type: integer
        totalProcessingTime:
          type: integer
    ApiError:
      type: object
      properties:
        errorCode:
          type: string
        message:
          type: string
    CreateQueryJobRequest:
      type: object
      description: Request body for creating a new query job
      required:
      - operation
      - query
      properties:
        operation:
          type: string
          description: The operation type
          enum:
          - query
          - queryAll
        query:
          type: string
          description: The SOQL query string
        columnDelimiter:
          type: string
          description: The column delimiter for the result CSV
          enum:
          - BACKQUOTE
          - CARET
          - COMMA
          - PIPE
          - SEMICOLON
          - TAB
          default: COMMA
        lineEnding:
          type: string
          description: The line ending for the result CSV
          enum:
          - LF
          - CRLF
          default: LF
  parameters:
    jobId:
      name: jobId
      in: path
      required: true
      description: The ID of the bulk job
      schema:
        type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: Salesforce OAuth 2.0 authentication
      flows:
        authorizationCode:
          authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
          tokenUrl: https://login.salesforce.com/services/oauth2/token
          scopes:
            api: Access and manage your Salesforce data
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth 2.0 Access Token
externalDocs:
  description: Bulk API 2.0 and Bulk API Developer Guide
  url: https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm