HEhere
Manage Jobs

List job inputs (flat or preview)

Changed on

Lists the available inputs of a job in flat mode, or a preview of the input groups with sets in paginated mode

get/jobs/{jobId}/inputs

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /jobs/{jobId}/inputs
  • Auth
    • API key in query parameter access_token
    • or HTTP bearer

Path parameters

jobIdstring required

The unique identifier of the job.

Headers

X-Response-Mode'regular' | 'paginated'

Optional response mode switch for list endpoints. If omitted, defaults to regular. - regular: return a flat list (legacy behavior). - paginated: return a page wrapper with items and nextPageToken.

Response

The job inputs (array or page wrapper when X-Response-Mode=paginated)

OR

Example response

[
  {
    "type": "UploadUrl",
    "s3Key": "import/h3TGlF/part_1.csv",
    "url": "https://foo.com/import/h3TGlF/part_1.csv"
  }
]

Changes

  • b0f3c1c4fc93Revision changes
    • breaking

      added subschema #1 to the response body oneOf list for the response status

    • breaking

      the response's body type changed from array to no type for status

    • info

      api operation id getJobInputs removed and replaced with getJobInputPayloadsPreview

    • info

      added the new optional header request parameter X-Response-Mode

  • f590d51a45beRevision changes
    • breaking

      the response's body type changed from no type to array for status

    • warning

      deleted the header request parameter X-Response-Mode

    • info

      api operation id getJobInputPayloadsPreview removed and replaced with getJobInputs

    • info

      removed subschema #1 from the response body oneOf list for the response status