Prompt Job

Get prompt jobs.

Called by the Independent Software Vendor. Lists all the prompt jobs in the database for the current organization.

get/prompt_jobs

Query parameters

limitinteger
Example:15

The limit of the returned list. Size range - 1..100

offsetinteger
Example:10

Specifies the offset of the returned list items. Size range - 0..

Headers

Authorizationstring api_id:api_token required

Needs to include Basic word before Base64 encoded api_id:api_token. The api_id is the identifier of the organization created on TAP; size range - up to 36 characters. The api_token is the unique token previously generated by TAP and provided securely to the organization; size range - 32. Example: Basic ODA5BVgrNdZkZmbiFlJlTThkYTA2eG00MzA5dHh1bWZnZgfdZDE=

Acceptstring required
Example:application/vnd.paymentfusion.v3.0.0+json

Specifies the requested API version. If this field is not specified or has an invalid format, the API will return an error. If the specified version does not exist, a 404 page will be displayed. Accepted values - application/vnd.paymentfusion.v3.0.0+json

Response

Success

totalinteger

The number of prompt jobs returned.

limitinteger

Specifies the limit of the returned list items. Size range - 1..100

offsetinteger

Specifies the offset of the returned list items. Size range - 0..

vstring

The API version that was used to handle the request.

Example response

{
  "results": [
    {
      "status": "string",
      "created_at": "string",
      "remote_id": "string"
    }
  ],
  "v": "string"
}