{
  "opencollection": "1.0.0",
  "info": {
    "name": "CaptivateIQ Attribute Worksheets Jobs API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Jobs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Job Aggregation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.captivateiq.com/ciq/v1/job-aggregations/",
            "params": [
              {
                "name": "job_status",
                "value": "",
                "type": "query",
                "description": "Filter by job status: PENDING, STARTED, SUCCESS, FAILURE, RETRY, or REVOKED."
              },
              {
                "name": "job_type",
                "value": "",
                "type": "query",
                "description": "Optional. Filter by specific job type, eg. payouts.jobs.process_payout."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The initial index from which to return the results."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Optional. Filter aggregations created on or after this date (YYYY-MM-DD). Defaults to 30 days ago."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "List details of job aggregations for the organization. Defaults to a 30-day lookback window;\npass `start_date` to override."
        },
        {
          "info": {
            "name": "Get Job Aggregation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.captivateiq.com/ciq/v1/job-aggregations/:job_aggregation_id/",
            "params": [
              {
                "name": "job_aggregation_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Get Job Aggregation"
        },
        {
          "info": {
            "name": "List Jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.captivateiq.com/ciq/v1/jobs/",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The initial index from which to return the results."
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Optional. Which field to use when ordering the results. By default we assume [`-created_at`]. Available fields for ordering: [`(-)created_at`, `(-)updated_at`]. See the [FAQs](https://developers.captivateiq.com/docs/faqs) page for tips."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Optional. Filter jobs created on or after this date (YYYY-MM-DD)."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "List Jobs"
        },
        {
          "info": {
            "name": "Get Job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.captivateiq.com/ciq/v1/jobs/:id/",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Primary key, a UUID."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Get Job"
        }
      ]
    }
  ],
  "bundled": true
}