Salesforce Sales Cloud Query Results API

openapi: 3.1.0
info:
  title: Salesforce Sales Cloud Salesforce Analytics REST Change Events Query Results API
  description: Access Salesforce reports, dashboards, and analytics data programmatically. Enables embedding analytics into custom applications, automating report generation, running reports synchronously or asynchronously, and managing dashboard components and filters.
  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/analytics
  description: Salesforce Production or Developer Edition
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce instance identifier
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Query Results
  description: Retrieve results from completed query jobs
paths:
  /jobs/query/{jobId}/results:
    get:
      operationId: getQueryJobResults
      summary: Salesforce Sales Cloud Get query job results
      description: Retrieves the results of a completed query job in CSV format. Use the locator and maxRecords parameters to paginate through large result sets.
      tags:
      - Query Results
      parameters:
      - $ref: '#/components/parameters/jobId'
      - name: locator
        in: query
        description: Locator value for retrieving the next set of results
        required: false
        schema:
          type: string
      - name: maxRecords
        in: query
        description: Maximum number of records to return per request
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Successfully retrieved query results
          headers:
            Sforce-Locator:
              description: Locator value for the next set of results (null if no more)
              schema:
                type: string
            Sforce-NumberOfRecords:
              description: Number of records in this result set
              schema:
                type: integer
          content:
            text/csv:
              schema:
                type: string
                description: CSV data of query results
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    jobId:
      name: jobId
      in: path
      required: true
      description: The ID of the bulk job
      schema:
        type: string
  responses:
    Unauthorized:
      description: Authentication failed or access token is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The specified job was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: array
      items:
        $ref: '#/components/schemas/ApiError'
    ApiError:
      type: object
      properties:
        errorCode:
          type: string
        message:
          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: Salesforce Reports and Dashboards REST API Developer Guide
  url: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/sforce_analytics_rest_api_intro.htm