Appcues Jobs API

The Jobs API from Appcues — 2 operation(s) for jobs.

OpenAPI Specification

appcues-jobs-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Appcues Public Banners Jobs API
  version: '2.0'
  description: 'The Appcues Public API exposes programmatic access to Appcues flows,

    mobile experiences, pins, launchpads, banners, checklists, embeds, NPS,

    segments, users, groups, events, and offline jobs. US and EU regions are

    supported. Authentication uses HTTP Basic with an API key as the username

    and API secret as the password.

    '
  contact:
    name: Appcues Developers
    url: https://docs.appcues.com/dev-overview/
servers:
- url: https://api.appcues.com
  description: US region
- url: https://api.eu.appcues.com
  description: EU region
security:
- BasicAuth: []
tags:
- name: Jobs
paths:
  /v2/accounts/{account_id}/jobs:
    get:
      tags:
      - Jobs
      summary: List offline jobs
      parameters:
      - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: OK
  /v2/accounts/{account_id}/jobs/{job_id}:
    get:
      tags:
      - Jobs
      summary: Get an offline job
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: job_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
components:
  parameters:
    AccountId:
      name: account_id
      in: path
      required: true
      description: Appcues account identifier
      schema:
        type: string
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using API_KEY as username and API_SECRET as password.