openapi: 3.0.3
info:
  title: Clickworker MP-API v2 (API Documentation)
  version: 2.0.42
  description: "# Clickworker Marketplace API v2\n\nThis collection provides the complete Clickworker Marketplace API v2 reference.\
    \ Use it to connect to clickworker's crowdsourced services and manage orders, submit tasks to the crowd, handle buyoff/review\
    \ flows, manage clickworker teams, and monitor your account.\n\n## Authentication\n\nThe API endpoints use **HTTP Basic\
    \ Auth** with your customer login (your customer email) and password (your customer password).\n\n## Environments\n\n\
    We provide sandbox and production environments to facilitate development, testing and productive use of the clickworker\
    \ Marketplace API. Each environment has an API endpoint through which your application communicates with the clickworker\
    \ platform, as well as a web-portal for customers and a web-portal intended for clickworkers working on projects and completing\
    \ tasks submitted via the API.\n\n#### Production Environment\n\nProduction environment uses the latest released version\
    \ of the Marketplace API and is operating on production level data. It fully interacts with external systems, like email\
    \ servers or partner gateways.\n\n#### Sandbox Environment\n\nThe sandbox environment is intended for development purposes\
    \ and integration testing. It uses the latest released version of the Marketplace API, and operates on dedicated test\
    \ data. This environment has limited interaction with external systems, like email servers or partner gateways. You may\
    \ use this environment to test your integration. Note, that no clickworkers are active on the sandbox environment. In\
    \ order to test your integration, you can act as a clickworker using the Clickworker Workplace by either registering there\
    \ as a clickworker account or contacting our marketplace support to create accounts for you.\n\n| Environment | API Endpoint\
    \ | Customer Portal | Clickworker Workplace |\n| --- | --- | --- | --- |\n| **Sandbox** | `https://api-sandbox.clickworker.com`\
    \ | `https://sandbox-clickworkermanagement.clickworker.com` | `https://sandbox-core5.clickworker.com` |\n| **Production**\
    \ | `https://api-production.clickworker.com` | `https://marketplace.clickworker.com` | `https://workplace.clickworker.com`\
    \ |\n\nIn order to access the Clickworker Workplace (Sandbox), contact our customer support at [helpdesk@clickworker.com](https://mailto:helpdesk@clickworker.com)\n\
    \n\n## Common Query Parameters\n\n| Param | Description |\n| --- | --- |\n| `_page_size` | Results per page (default 50,\
    \ max 50) |\n| `_page_number` | Page number (1-based) |\n| `_suppress_http_status=1` | If set, always return HTTP 200;\
    \ check `request_status` in the response body for the real status |\n| `_method` | Override HTTP method (`PUT` or `DELETE`)\
    \ when using POST |\n\n## Request Headers\n\nFor requests sent to the API, ensure that the following HTTP headers are\
    \ set correctly:\n\n- Content-Type = application/json\n    \n- Accept = application/json\n    \n\n## Response Format\n\
    \nAll responses include a `request_status` object with `status_code`, `valid`, `messages`, and pagination info (`total_count`,\
    \ `page_size`, `page_num`).\n\n## Getting Support\n\nIf you have questions about our products or need assistance during\
    \ integration, please contact our Self Service / Marketplace Support team at [https://www.clickworker.com/contact-for-customers/](https://www.clickworker.com/contact-for-customers/)."
  contact:
    name: Clickworker Marketplace Support
    url: https://www.clickworker.com/contact-for-customers/
    email: helpdesk@clickworker.com
  license:
    name: Proprietary
    url: https://www.clickworker.com/terms/
servers:
- url: https://api-sandbox.clickworker.com
  description: Sandbox Environment
- url: https://api-production.clickworker.com
  description: Production Environment
security:
- basicAuth: []
tags:
- name: Getting Started
  description: |-
    Verify your connection to the Clickworker MP-API and explore your account details.

    Start with the **Echo** endpoints to confirm connectivity, then check your **Customer Balance**.
- name: Products
  description: "Each service available through the Marketplace API is backed by a defined production workflow, including built-in\
    \ quality assurance mechanisms, pricing structures, and configurable options tailored to your use case.\n\nWe currently\
    \ offer the following core products:\n\n- **Survey** – Invite a targeted group of clickworkers to participate in your\
    \ survey and collect high-quality primary data at scale.\n    \n- **Sentiment** – Leverage crowd-based majority voting\
    \ to evaluate opinions, classifications, or subjective judgments on your content.\n    \n- **iFrame** – Enable clickworkers\
    \ to operate directly within your own system or interface via embedded workflows.\n    \n\nIn addition to these standard\
    \ offerings, our Operations team can configure custom products designed to meet specific client requirements, workflows,\
    \ or quality criteria."
- name: Task Templates
  description: "# Task Templates\n\nTask Templates define the **blueprint** for the work to be delivered - the tasks. They\
    \ specify:\n\n- Which **product** (task type) to use\n    \n- The **form** workers will fill out\n    \n- Targeting attributes\
    \ (country, language, age range, gender, etc.)\n    \n- Titles and descriptions shown to clickworkers\n    \n\nA template\
    \ must be created before tasks can be submitted. The `code` field is your unique identifier for the template — choose\
    \ something meaningful like `image_classification_v1`.\n\n> **Important:** Once a template is created, its `product` and\
    \ `form` cannot be modified. Create a new template if you need to change the task structure."
- name: Tasks
  description: "# Tasks\n\nTasks are individual work items submitted to the crowd. Each task is based on a **task template**\
    \ and carries the input data for one specific unit of work.\n\n## Task lifecycle\n\nA **Task** represents the full unit\
    \ of work you submit to the platform (e.g., creating an article based on a briefing). Each Task is automatically broken\
    \ down into one or more **Jobs**, where each Job corresponds to a specific step in the workflow.\n\nThe sequence and number\
    \ of Jobs depend on the selected product and the configured quality assurance (QA) level. For example, a Task may include\
    \ separate Jobs for content creation, review, and final approval.\n\n### How it works\n\nOnce a Task is submitted, it\
    \ progresses through the following lifecycle:\n\n- The Task is distributed to the crowd, and clickworkers begin working\
    \ on the first Job (e.g., content creation).\n    \n- Depending on your QA configuration, additional Jobs may follow,\
    \ such as peer review or expert review (e.g., via a lecturer service).\n    \n- After all preceding Jobs are completed,\
    \ the Task reaches the final step: the **buyoff Job**, where the result is sent to you for approval or rejection.\n  \
    \  \n\n```\ncreated → queued → running → finished\n                          ↘ timedout\n                          ↘ cancelled\n\
    \                          ↘ feedback (buyoff)\n\n ```\n\n#### **Task States:**\n\n- **created** – Task is created and\
    \ automatically confirmed via the API\n    \n- **queued** – Task is waiting to be picked up by the crowd\n    \n- **running**\
    \ – At least one Job is actively being worked on\n    \n- **finished** – All Jobs are completed successfully\n    \n-\
    \ **timedout** – A Job was not completed within the allowed time\n    \n- **cancelled** – Task was stopped before completion\n\
    \    \n- **feedback (buyoff)** – Task is awaiting your final approval decision\n    \n\nUse the `state` filter in the\
    \ index to monitor progress: `running`, `finished`, `timedout`, `cancelled`, `feedback`.\n\n### Quality Assurance / BuyOff\n\
    \nDepending on the product, results are reviewed by trusted validators. In addition, you have the option to perform a\
    \ final review and explicitly accept or reject a result via the API.\n\nThe final approval step—referred to as the “buyoff\
    \ job”—is part of a multi-stage workflow. Each task is divided into several jobs, with each job representing a specific\
    \ step in the overall process. For example, if quality assurance is enabled, at least three jobs are involved:\n\n1. **Content\
    \ creation** – generating the initial result\n    \n2. **Content review** – validating the generated result\n    \n3.\
    \ **Buyoff job** – making the final approval or rejection decision\n    \n\nIn the testing environment (“sandbox”), the\
    \ customer must complete the first two jobs through the clickworker workplace before the task reaches the buyoff stage.\
    \ The buyoff job then presents the final results and requests your approval decision.\n\nTo approve or reject a result,\
    \ you must submit the corresponding decision via the API. This approval data is essential, as it directly impacts clickworker\
    \ ratings and plays a crucial role in maintaining high-quality outcomes across your projects.\n\n- For buyoff flows, tasks\
    \ emit a `CUSTOMER_INPUT_REQUIRED` notification and wait for your `accept` or `reject` call.\n    \n- Use `payload=extended`\
    \ on the index to retrieve full results inline without individual show calls.\n    \n\n### Results\n\nCompleting your\
    \ tasks by the crowd will take some time, depending on the complextity of the work and availability of workers taking\
    \ on your task. At any time you may have multiple tasks submitted and ongoing. The order of completion may be different\
    \ than the order of submitting tasks.\n\nThere are two options to get an overview of your active and completed tasks:\n\
    \n- **Option 1 - Polling / Pull approach**: You may check regularly which of your tasks have been completed\n    \n- **Option\
    \ 2 - Push notification / Notification approach:** When submitting a new task, you may add a Notification URL which will\
    \ be called when the task has been completed or needs your feedback, in case BuyOff has been enabled. Push notifications\
    \ are highly recommended as it is superior in terms of performance and load on your client system.\n    \n\n## Notifications\n\
    \nSet `notifications` on task creation to receive webhook callbacks on events like\n\n- `TASK_COMPLETED - when results\
    \ are final`\n    \n- `TASK_TIMEDOUT - when the task could not be completed in time`\n    \n- `CUSTOMER_INPUT_REQUIRED\
    \ - if your approval/rejection of results is required`\n    \n\nAdd `\"payload\": \"extended\"` to include full task data\
    \ in the callback."
- name: Teams
  description: |-
    # Teams

    Teams allow you to group specific clickworkers and target tasks exclusively to that group. This is useful for:
    - Building a **trusted panel** of pre-vetted workers
    - Running **internal quality assurance** workflows
    - Targeting tasks to workers with specific qualifications

    Workers are referenced by their numeric `user_id`. Use `Teams.update` to add or remove members.
- name: Jobs
  description: |-
    # Jobs

    Jobs represent the **unit of work assigned to an individual clickworker** within a task. A single task may spawn multiple jobs (e.g. when multiple participants are required, or when a job is rejected and reassigned).

    In **buyoff flows**, jobs enter a customer-review state where you can inspect the worker's input and submit your approval decision via `Job.update`.

    Use `Jobs.index` to monitor pending review jobs across all tasks, or `Jobs.index (by task)` to scope to a specific task.
- name: Notifications
  description: |-
    # Notifications

    Notifications let you register **webhook callbacks** that the API will call when specific task events occur. This eliminates the need to poll for task status changes.

    ## Supported events

    | Event | Triggered when |
    |---|---|
    | `TASK_COMPLETED` | All workers have submitted results |
    | `TASK_TIMEDOUT` | Task expired before completion |
    | `CUSTOMER_INPUT_REQUIRED` | Buyoff task awaiting your review |

    ## Callback payload

    The API will `POST` to your `callback_url` with a JSON body containing the event type and task details. Respond with HTTP 200 to acknowledge receipt.

    Use `NotificationListener.log` as a test endpoint to see what payloads look like.
- name: Clickworkers
  description: |-
    # Clickworkers

    Query information about the clickworker population — useful for estimating task availability and understanding the demographic composition of your target group before submitting tasks.

    ## Geographic queries

    Use the `count_in_range` and `count_in_bounding_box` methods to see how many workers are active in a given area. This helps validate geographic targeting before launching location-based tasks.

    ## Demographics

    Query demographic data (gender, age, location) for specific clickworkers. Useful for reporting and quality analysis.
- name: Orders
  description: |-
    # Orders

    Orders group related tasks together for billing and reporting. Tasks submitted together are typically part of the same order.
- name: Allow/Block List Copy
  description: Allow and Block Lists permit you to exclude or unconditionally allow clickworkers from your order.
- name: Customer Account Management
  description: |-
    # Customer Account Management

    Endpoints for managing customer accounts — registration, authentication, password management, and utility lookups.

    Most endpoints in this folder use **no authentication** as they are part of the account creation and recovery flow. Exceptions are noted per request.
- name: Product Survey
  description: Use the Survey tool for polls and surveys targeted to a group of clickworkers matching a profile. Clickworker
    results are not quality assured, to provide you the unfiltered feedback.
- name: Product Sentiment
  description: Invite a targeted group of clickworkers to participate in your survey and collect high-quality primary data
    at scale.
- name: Product iFrame
  description: Step-by-step example workflow for the ExternalForm (iFrame) product — from template creation through task submission,
    external postback, buyoff review, and task monitoring.
x-tagGroups:
- name: API Reference
  tags:
  - Getting Started
  - Products
  - Task Templates
  - Tasks
  - Teams
  - Jobs
  - Notifications
  - Clickworkers
  - Orders
  - Allow/Block List Copy
  - Customer Account Management
- name: Examples
  tags:
  - Product Survey
  - Product Sentiment
  - Product iFrame
paths:
  /api/marketplace/v2/echo/simple_echo:
    post:
      tags:
      - Getting Started
      - Product Survey
      - Product Sentiment
      - Product iFrame
      summary: Echo (no auth)
      description: |-
        ## Echo (no auth)

        A simple connectivity test that requires **no authentication**. The API will echo back the message you send.

        Use this to verify:
        - The API base URL (`{{baseUrlEndpoint}}`) is correct
        - Your network can reach the API
        - The API is responding

        **No credentials required.**
      operationId: echoNoAuth
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              Echo__no_auth:
                summary: Echo (no auth)
                value:
                  echo:
                    message: Hello World
              01___Echo__wo_auth:
                summary: 01 - Echo (wo auth)
                value:
                  echo:
                    message: Hello world now
              01___Echo__wo_auth_2:
                summary: 01 - Echo (wo auth)
                value:
                  echo:
                    message: Hello world now
      security: []
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X POST \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/echo/simple_echo' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"echo": {"message": "Hello World"}}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/echo/simple_echo"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          payload = {
            "echo": {
              "message": "Hello World"
            }
          }

          response = requests.post(
              url,
              headers=headers,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/echo/simple_echo", {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
            },
            body: JSON.stringify({
            "echo": {
              "message": "Hello World"
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/echo/simple_echo");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"echo": {"message": "Hello World"}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/echo/simple_echo")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Post.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.body = {
            "echo": {
              "message": "Hello World"
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/echo/extended_echo:
    post:
      tags:
      - Getting Started
      summary: Echo Extended (auth required)
      description: |-
        ## Echo Extended (auth required)

        An authenticated connectivity test. Use this to verify that your **Basic Auth credentials** (`{{user}}` / `{{password}}`) are correct and working.

        The response echoes the message back along with your authenticated customer context.
      operationId: echoExtendedAuthRequired
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                echo:
                  type: object
                  properties:
                    message:
                      type: string
            example:
              echo:
                message: Hello World
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X POST \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/echo/extended_echo' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"echo": {"message": "Hello World"}}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/echo/extended_echo"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "echo": {
              "message": "Hello World"
            }
          }

          response = requests.post(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/echo/extended_echo", {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "echo": {
              "message": "Hello World"
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/echo/extended_echo");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"echo": {"message": "Hello World"}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/echo/extended_echo")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Post.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "echo": {
              "message": "Hello World"
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer:
    get:
      tags:
      - Getting Started
      - Customer Account Management
      - Product Survey
      - Product Sentiment
      - Product iFrame
      summary: Customer Balance / Customer.show
      description: |-
        ### Customer Balance

        ## Customer Balance

        Returns your account's current financial status.

        **Response fields:**

        | Field | Description |
        |---|---|
        | `balance_amount` | Current available balance |
        | `reserved_amount` | Amount reserved for running tasks |
        | `credit_limit` | Maximum credit available |
        | `currency_code` | Account currency (e.g. `EUR`, `USD`) |

        Check your balance before submitting large task batches to ensure sufficient funds.

        ---

        ### Customer.show

        ## Customer.show

        Returns account balance and account details. Requires Basic Auth.

        Returns `balance_amount`, `reserved_amount`, `credit_limit`, and `currency_code`.
      operationId: customerBalance
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/products:
    get:
      tags:
      - Products
      - Product Survey
      - Product Sentiment
      - Product iFrame
      summary: Products (list)
      description: "## Products (list)\n\nLists all products available to your account. Each product represents a **task type**\
        \ that clickworkers can perform.\n\nCommon products include:\n\n- `Survey` — Survey or questionnaire tasks\n    \n\
        - `ExternalForm` — iFrame-based tasks hosted on your own platform\n    \n- `Sentiment` — Sentiment analysis\n    \n\
        \nUse the product `code` from this list when creating task templates."
      operationId: productsList
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/products' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/products"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/products", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/products");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/products")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/products/{productCode}:
    get:
      tags:
      - Products
      summary: Product Details
      description: |-
        ## Product Details

        Returns full details for a specific product including all **required and optional attributes** you must supply when creating a task template.

        Replace `{{productCode}}` with a product code from the Products list (e.g. `Survey`, `ExternalForm`, `TextCreate`).

        The response includes:
        - All configurable attributes with their codes, types, and validation rules
        - Pricing information
        - Supported form element types
      operationId: productDetails
      parameters:
      - name: productCode
        in: path
        required: true
        description: Product code, e.g. Survey, ExternalForm, TextCreate
        schema:
          type: string
          example: Survey
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/products/{productCode}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/products/{productCode}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/products/{productCode}", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/products/{productCode}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/products/{productCode}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/task_templates:
    get:
      tags:
      - Task Templates
      - Product Survey
      - Product Sentiment
      - Product iFrame
      summary: TaskTemplates.index
      description: |-
        ## TaskTemplates.index

        Lists all task templates for your account.

        Templates with `is_draft: true` are not yet active. Set `is_draft: false` to make a template available for task creation.
      operationId: tasktemplatesindex
      parameters:
      - name: _page_size
        in: query
        required: false
        description: Results per page
        schema:
          type: string
          example: '50'
      - name: _page_number
        in: query
        required: false
        description: Page number (1-based)
        schema:
          type: string
          example: '1'
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates?_page_size=50&_page_number=1' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates"
          params = {
              "_page_size": "50",
              "_page_number": "1",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              params=params,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates?_page_size=50&_page_number=1", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates?_page_size=50&_page_number=1");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates?_page_size=50&_page_number=1")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
    post:
      tags:
      - Task Templates
      - Product Survey
      - Product Sentiment
      - Product iFrame
      summary: TaskTemplate.create (Survey) / TaskTemplate.create (ExternalForm / iFrame) / TaskTemplate.create (TextCreate)
      description: |-
        ### TaskTemplate.create (Survey)

        ## TaskTemplate.create (Survey)

        Creates a **Survey** task template. Workers answer structured questions you define.

        **Key product attributes for Survey:**

        | Attribute | Description |
        |---|---|
        | `mp_df_survey_country` | Target countries (array of ISO codes) |
        | `mp_df_survey_payment` | Payment in cents |
        | `mp_df_survey_participants` | Number of workers per task |
        | `mp_df_survey_age_from` / `mp_df_survey_age_to` | Age range filter |
        | `mp_df_survey_gender` | Gender filter: `m`, `f`, or `b` (both) |
        | `mp_df_survey_expiration` | Task expiry date (YYYY-MM-DD) |
        | `mp_df_survey_language` | Target languages (array) |

        **Form elements:**
        - `text_field` — free text input
        - `check_box` — single or multiple choice
        - `radio_button` — single choice
        - `text_area` — multi-line text
        - `rating` — star/numeric rating

        Set `is_output: true` on fields you want returned in results. Set `is_mandatory: true` for required fields.

        ---

        ### TaskTemplate.create (ExternalForm / iFrame)

        ## TaskTemplate.create (ExternalForm / iFrame)

        Creates an **ExternalForm** task template. The task is presented to workers as an embedded iFrame pointing to your own web application.

        **Key product attributes for ExternalForm:**

        | Attribute | Type | Description |
        |---|---|---|
        | `external_form_country` | array | Target countries (ISO codes, e.g. `["US", "DE"]`) |
        | `external_form_payment` | integer | Payment in cents per task |
        | `external_form_max_jobs` | integer | Maximum number of jobs per task |
        | `external_form_multiple_jobs` | string | `"yes"` or `"no"` — whether a worker can do multiple jobs |
        | `external_form_expiration` | string | Task expiry date (YYYY-MM-DD) |
        | `external_form_language` | array | Target languages (e.g. `["en"]`) |
        | `external_form_age_from` / `age_to` | string | Age range filter |
        | `external_form_gender` | string | `"m"`, `"f"`, or `"b"` (both) |
        | `external_form_timeout` | string | Per-job timeout offset |
        | `external_form_skill` | array | Required skills (optional) |
        | `external_form_interest` | array | Required interests (optional) |
        | `external_form_team_whitelist` | string | Team ID for whitelist targeting (optional) |
        | `external_form_team_blacklist` | string | Team ID for blacklist exclusion (optional) |

        The `iframe_url` input item carries the per-task URL passed to the worker's iFrame. The worker submits results through your form, and your server calls `external_submit` to post them back.

        To enable the **buyoff flow** (where you approve/reject each submission), configure the product workflow to include a buyoff step. You will receive `CUSTOMER_INPUT_REQUIRED` notifications and use `Task.accept` / `Task.reject` to process them.

        ---

        ### TaskTemplate.create (TextCreate)

        ## TaskTemplate.create (TextCreate)

        Creates a **TextCreateWithKeywords** task template. Workers write original text (e.g. product descriptions, blog posts) using keywords you supply per task.

        **Product attributes for TextCreateWithKeywords:**

        | Attribute | Type | Description |
        |---|---|---|
        | `textcreatewithkeywords_language` | string | Target language code (e.g. `"en"`, `"de"`) |
        | `textcreatewithkeywords_text_length` | string | Word count range as `"min#max"` (e.g. `"80#120"`) |
        | `textcreatewithkeywords_proof_read` | string | Proof-reading option: `"textcreate_proof_no"` or `"textcreate_proof_yes"` |
        | `textcreatewithkeywords_team_whitelist` | string | Team ID for whitelist targeting (optional) |
        | `textcreatewithkeywords_team_blacklist` | string | Team ID for blacklist exclusion (optional) |

        **Form elements used in this example:**
        - `topic` — input text field shown to the worker as the writing topic
        - `result` — output text area where the worker writes the text; enforced by `min_length`/`max_length` options
        - `keyword_a` — keyword element; the worker's text is checked for keyword density using `min_occurrence_ref`/`max_occurrence_ref` data from the task input
      operationId: tasktemplatecreateSurvey
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              TaskTemplate_create__Survey:
                summary: TaskTemplate.create (Survey)
                value:
                  task_template:
                    code: survey_template_002
                    name: My Survey Template
                    titles:
                      en: Survey Title
                      de: Umfrage Titel
                    descriptions:
                      en: Survey description
                      de: Beschreibung
                    is_draft: false
                    product:
                      link:
                        href: '{{baseUrlEndpoint}}/api/marketplace/v2/products/Survey'
                        rel: product
                        type: application/json
                      attributes:
                      - code: mp_df_survey_country
                        value:
                        - US
                        - DE
                      - code: mp_df_survey_payment
                        value: 40
                      - code: mp_df_survey_participants
                        value: 3
                      - code: mp_df_survey_age_from
                        value: '18'
                      - code: mp_df_survey_age_to
                        value: '99'
                      - code: mp_df_survey_gender
                        value: m
                      - code: mp_df_survey_expiration
                        value: '2026-12-31'
                      - code: mp_df_survey_language
                        value:
                        - en
                        - de
                    form:
                      elements:
                      - type: text_field
                        item_code: image_url
                        titles:
                          en: Image URL
                          de: Bild URL
                        is_output: false
                        is_mandatory: false
                      - type: check_box
                        item_code: rating
                        titles:
                          en: How would you rate this?
                          de: Wie würden Sie das bewerten?
                        is_output: true
                        is_mandatory: true
                        options:
                        - code: alternatives
                          value:
                          - value: good
                            titles:
                              en: Good
                              de: Gut
                          - value: bad
                            titles:
                              en: Bad
                              de: Schlecht
              TaskTemplate_create__ExternalForm___iFrame:
                summary: TaskTemplate.create (ExternalForm / iFrame)
                value:
                  task_template:
                    code: external_form_template_001
                    name: My External Form Template
                    titles:
                      en: External Task
                      de: Externe Aufgabe
                    descriptions:
                      en: Please complete the task in the embedded form.
                      de: Bitte erledigen Sie die Aufgabe im eingebetteten Formular.
                    is_draft: false
                    product:
                      link:
                        href: '{{baseUrlEndpoint}}/api/marketplace/v2/products/ExternalForm'
                        rel: product
                        type: application/json
                      attributes:
                      - code: external_form_country
                        value:
                        - US
                        - DE
                      - code: external_form_payment
                        value: 50
                      - code: external_form_max_jobs
                        value: 1
                      - code: external_form_multiple_jobs
                        value: 'no'
                      - code: external_form_expiration
                        value: '2026-12-31'
                      - code: external_form_language
                        value:
                        - en
                      - code: external_form_age_from
                        value: '18'
                      - code: external_form_age_to
                        value: '99'
                      - code: external_form_gender
                        value: b
                    form:
                      elements:
                      - type: text_field
                        item_code: iframe_url
                        titles:
                          en: Task URL
                        is_output: false
                        is_mandatory: true
              TaskTemplate_create__TextCreate:
                summary: TaskTemplate.create (TextCreate)
                value:
                  task_template:
                    code: text_create_template_002
                    name: My Text Creation Template
                    titles:
                      en: Write a Product Description
                      de: Schreiben Sie eine Produktbeschreibung
                    descriptions:
                      en: Write a product description (80-120 words) using the given keywords.
                      de: Schreiben Sie eine Produktbeschreibung (80-120 Woerter) mit den vorgegebenen Schuesselwoertern.
                    is_draft: false
                    product:
                      link:
                        href: '{{baseUrlEndpoint}}/api/marketplace/v2/products/TextCreateWithKeywords'
                        rel: product
                        type: application/json
                      attributes:
                      - code: textcreatewithkeywords_language
                        value: en
                      - code: textcreatewithkeywords_text_length
                        value: 80#120
                      - code: textcreatewithkeywords_proof_read
                        value: textcreate_proof_no
                    form:
                      elements:
                      - type: text_field
                        item_code: topic
                        titles:
                          en: Topic
                          de: Thema
                        is_output: false
                        is_mandatory: false
                      - type: text_area
                        item_code: result
                        titles:
                          en: Your Text
                          de: Ihr Text
                        is_output: true
                        is_mandatory: true
                        options:
                        - code: min_length
                          value: '80'
                        - code: max_length
                          value: '120'
                      - type: keyword
                        item_code: keyword_a
                        is_output: false
                        is_mandatory: true
                        options:
                        - code: min_occurrence_ref
                          value: keyword_a_min
                        - code: max_occurrence_ref
                          value: keyword_a_max
                        - code: reference_code
                          value: all
              07_2_TaskTemplate_Create__Survey:
                summary: 07.2 TaskTemplate Create (Survey)
                value:
                  task_template:
                    code: survey_template_002
                    name: CR-Test05
                    titles:
                      en: CR-Test05
                      de: CR-Test05
                    descriptions:
                      en: CR-Test05
                      de: CR-Test05
                    product:
                      link:
                        href: https://api-sandbox.clickworker.com/en/api/marketplace/v2/products/Survey
                        type: application/json
                        rel: product
                      attributes:
                      - code: mp_df_survey_country
                        value:
                        - US
                        - DE
                      - code: mp_df_survey_payment
                        value: 40
                      - code: mp_df_survey_participants
                        value: 3
                      - code: mp_df_survey_age_from
                        value: '18'
                      - code: mp_df_survey_age_to
                        value: '99'
                      - code: mp_df_survey_gender
                        value: m
                      - code: mp_df_survey_expiration
                        value: '2021-12-30'
                      - code: mp_df_survey_same_topic_for_all
                        value: 'yes'
                      - code: mp_df_survey_language
                        value:
                        - de
                        - en
                      - code: mp_df_survey_skill
                        value:
                        - computers_internet_programming
                        - natural_sciences_physics
                      - code: mp_df_survey_interest
                        value:
                        - computers_internet_computer_video_games
                    form:
                      elements:
                      - descriptions:
                          en: ''
                          de: ''
                        options:
                        - value: false
                          code: is_richtext
                        - value: false
                          code: is_html
                        titles:
                          en: ImageURL
                          de: ImageURL
                        min_count: 0
                        html_attributes: {}
                        is_output: false
                        is_mandatory: false
                        source: null
                        detailed_instructions:
                          en: null
                          de: null
                        sort_order: 1
                        type: text_field
                        item_code: imageurl
                      - descriptions:
                          en: ''
                          de: ''
                        options:
                        - value:
                          - value: 'Yes'
                          - value: 'No'
                          code: values
                        - value: false
                          code: is_richtext
                        - value: false
                          code: is_html
                        titles:
                          en: Do you like it
                          de: Do you like it
                        min_count: 0
                        html_attributes: {}
                        is_output: true
                        is_mandatory: false
                        source: null
                        detailed_instructions:
                          en: null
                          de: null
                        sort_order: 2
                        type: check_box
                        item_code: do_you_like_it
              07_2_TaskTemplate_Create__Sentiment:
                summary: 07.2 TaskTemplate Create (Sentiment)
                value:
                  task_template:
                    code: sentiment_20210329
                    name: My Sentiment Test 2021-03-29
                    titles:
                      en: My Sentiment Test 2021-03-29
                      de: Mein Sentiment Test 2021-03-29
                    descriptions:
                      en: Sentiment Test
                      de: Sentiment Test
                    product:
                      link:
                        href: https://api-sandbox.clickworker.com/en/api/marketplace/v2/products/Sentiment
                        type: application/json
                        rel: product
                      attributes:
                      - code: mp_df_sentiment_country
                        value:
                        - US
                        - DE
                      - code: mp_df_sentiment_payment
                        value: 40
                      - code: mp_df_sentiment_age_from
                        value: '18'
                      - code: mp_df_sentiment_age_to
                        value: '99'
                      - code: mp_df_sentiment_gender
                        value: a
                      - code: mp_df_sentiment_expiration
                        value: '2021-12-30'
                      - code: mp_df_sentiment_num_of_same_results
                        value: 2
                    form:
                      elements:
                      - sort_order: 1
                        type: image
                        item_code: photo_url
                        titles:
                          en: Photo 1
                          de: Foto 1
                        descriptions:
                          en: Is the photo showing a person?
                          de: Ist auf dem Foto ein Person zu sehen?
                        is_output: false
                      - sort_order: 2
                        type: check_box
                        item_code: is_person
                        is_output: true
                        is_mandatory: true
                        options:
                        - value:
                          - value: 'Yes'
                          - value: 'No'
                          code: values
                        titles:
                          en: Answer
                          de: Antwort
                        descriptions:
                          en: Does the photo show a person?
                          de: Ist auf dem Foto eine Person zu sehen?
                        detailed_instructions:
                          en: Answer 'Yes' if the photo shows a person.
                          de: Antworten Sie mit Yes, wenn eine Person zu sehen ist.
              05_TaskTemplate_Create__iFrame_noBuyoff:
                summary: 05 TaskTemplate Create (iFrame noBuyoff)
                value:
                  task_template:
                    code: api_iframe_test_25_09
                    titles:
                      de: External Form Test with 60
                      en: External Form Test with 60
                    is_draft: false
                    name: External Form Test
                    product:
                      attributes:
                      - value: BE
                        code: external_form_country
                      - value: 10
                        code: external_form_payment
                      - value: '98'
                        code: external_form_age_from
                      - value: '99'
                        code: external_form_age_to
                      - value: f
                        code: external_form_gender
                      - value: 'no'
                        code: external_form_with_buyoff
                      - value: 3600
                        code: external_form_timeout
                      - value: 20
                        code: external_form_max_jobs
                      - value: 'no'
                        code: external_form_multiple_jobs
                      link:
                      - href: '{{baseUrlEndpoint}}/api/marketplace/v2/products/ExternalForm'
                        type: application/json
                        rel: product
                    descriptions:
                      de: <p>Visit the website and search for the keyword:</p>
                      en: <p>Visit the website and search for the keyword:</p>
                    form:
                      elements:
                      - is_output: false
                        is_mandatory: true
                        titles:
                          en: Website URL
                          de: Website Adresse
                        type: hidden
                        item_code: iframe_url
                        sort_order: 10
              05_TaskTemplate_Create__iFrame_withBuyoff:
                summary: 05 TaskTemplate Create (iFrame withBuyoff)
                value:
                  task_template:
                    code: api_iframe_test_25_09_with_review
                    titles:
                      de: External Form Test api_iframe_test_25_09_with_review
                      en: External Form Test api_iframe_test_25_09_with_review
                    is_draft: false
                    name: External Form Test
                    product:
                      attributes:
                      - value: DE
                        code: external_form_country
                      - value: 10
                        code: external_form_payment
                      - value: '18'
                        code: external_form_age_from
                      - value: '99'
                        code: external_form_age_to
                      - value: f
                        code: external_form_gender
                      - value: 'yes'
                        code: external_form_with_buyoff
                      - value: 3600
                        code: external_form_timeout
                      - value: 2
                        code: external_form_max_jobs
                      - value: 'no'
                        code: external_form_multiple_jobs
                      link:
                      - href: '{{baseUrlEndpoint}}/api/marketplace/v2/products/ExternalForm'
                        type: application/json
                        rel: product
                    descriptions:
                      de: <p>Visit the website and search for the keyword:</p>
                      en: <p>Visit the website and search for the keyword:</p>
                    form:
                      elements:
                      - is_output: false
                        is_mandatory: true
                        titles:
                          en: Website URL
                          de: Website Adresse
                        type: hidden
                        item_code: iframe_url
                        sort_order: 10
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X POST \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '
          {
            "task_template": {
              "code": "survey_template_002",
              "name": "My Survey Template",
              "titles": {
                "en": "Survey Title",
                "de": "Umfrage Titel"
              },
              "descriptions": {
                "en": "Survey description",
                "de": "Beschreibung"
              },
              "is_draft": false,
              "product": {
                "link": {
                  "href": "{{baseUrlEndpoint}}/api/marketplace/v2/products/Survey",
                  "rel": "product",
                  "type": "application/json"
                },
                "attributes": [
                  {
                    "code": "mp_df_survey_country",
                    "value": [
                      "US",
                      "DE"
                    ]
                  },
                  {
                    "code": "mp_df_survey_payment",
                    "value": 40
                  },
                  {
                    "code": "mp_df_survey_participants",
                    "value": 3
                  },
                  {
                    "code": "mp_df_survey_age_from",
                    "value": "18"
                  },
                  {
                    "code": "mp_df_survey_age_to",
                    "value": "99"
                  },
                  {
                    "code": "mp_df_survey_gender",
                    "value": "m"
                  },
                  {
                    "code": "mp_df_survey_expiration",
                    "value": "2026-12-31"
                  },
                  {
                    "code": "mp_df_survey_language",
                    "value": [
                      "en",
                      "de"
                    ]
                  }
                ]
              },
              "form": {
                "elements": [
                  {
                    "type": "text_field",
                    "item_code": "image_url",
                    "titles": {
                      "en": "Image URL",
                      "de": "Bild URL"
                    },
                    "is_output": false,
                    "is_mandatory": false
                  },
                  {
                    "type": "check_box",
                    "item_code": "rating",
                    "titles": {
                      "en": "How would you rate this?",
                      "de": "Wie w\u00fcrden Sie das bewerten?"
                    },
                    "is_output": true,
                    "is_mandatory": true,
                    "options": [
                      {
                        "code": "alternatives",
                        "value": [
                          {
                            "value": "good",
                            "titles": {
                              "en": "Good",
                              "de": "Gut"
                            }
                          },
                          {
                            "value": "bad",
                            "titles": {
                              "en": "Bad",
                              "de": "Schlecht"
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          }
          '
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "task_template": {
              "code": "survey_template_002",
              "name": "My Survey Template",
              "titles": {
                "en": "Survey Title",
                "de": "Umfrage Titel"
              },
              "descriptions": {
                "en": "Survey description",
                "de": "Beschreibung"
              },
              "is_draft": false,
              "product": {
                "link": {
                  "href": "{{baseUrlEndpoint}}/api/marketplace/v2/products/Survey",
                  "rel": "product",
                  "type": "application/json"
                },
                "attributes": [
                  {
                    "code": "mp_df_survey_country",
                    "value": [
                      "US",
                      "DE"
                    ]
                  },
                  {
                    "code": "mp_df_survey_payment",
                    "value": 40
                  },
                  {
                    "code": "mp_df_survey_participants",
                    "value": 3
                  },
                  {
                    "code": "mp_df_survey_age_from",
                    "value": "18"
                  },
                  {
                    "code": "mp_df_survey_age_to",
                    "value": "99"
                  },
                  {
                    "code": "mp_df_survey_gender",
                    "value": "m"
                  },
                  {
                    "code": "mp_df_survey_expiration",
                    "value": "2026-12-31"
                  },
                  {
                    "code": "mp_df_survey_language",
                    "value": [
                      "en",
                      "de"
                    ]
                  }
                ]
              },
              "form": {
                "elements": [
                  {
                    "type": "text_field",
                    "item_code": "image_url",
                    "titles": {
                      "en": "Image URL",
                      "de": "Bild URL"
                    },
                    "is_output": false,
                    "is_mandatory": false
                  },
                  {
                    "type": "check_box",
                    "item_code": "rating",
                    "titles": {
                      "en": "How would you rate this?",
                      "de": "Wie w\u00fcrden Sie das bewerten?"
                    },
                    "is_output": true,
                    "is_mandatory": true,
                    "options": [
                      {
                        "code": "alternatives",
                        "value": [
                          {
                            "value": "good",
                            "titles": {
                              "en": "Good",
                              "de": "Gut"
                            }
                          },
                          {
                            "value": "bad",
                            "titles": {
                              "en": "Bad",
                              "de": "Schlecht"
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          }

          response = requests.post(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates", {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "task_template": {
              "code": "survey_template_002",
              "name": "My Survey Template",
              "titles": {
                "en": "Survey Title",
                "de": "Umfrage Titel"
              },
              "descriptions": {
                "en": "Survey description",
                "de": "Beschreibung"
              },
              "is_draft": false,
              "product": {
                "link": {
                  "href": "{{baseUrlEndpoint}}/api/marketplace/v2/products/Survey",
                  "rel": "product",
                  "type": "application/json"
                },
                "attributes": [
                  {
                    "code": "mp_df_survey_country",
                    "value": [
                      "US",
                      "DE"
                    ]
                  },
                  {
                    "code": "mp_df_survey_payment",
                    "value": 40
                  },
                  {
                    "code": "mp_df_survey_participants",
                    "value": 3
                  },
                  {
                    "code": "mp_df_survey_age_from",
                    "value": "18"
                  },
                  {
                    "code": "mp_df_survey_age_to",
                    "value": "99"
                  },
                  {
                    "code": "mp_df_survey_gender",
                    "value": "m"
                  },
                  {
                    "code": "mp_df_survey_expiration",
                    "value": "2026-12-31"
                  },
                  {
                    "code": "mp_df_survey_language",
                    "value": [
                      "en",
                      "de"
                    ]
                  }
                ]
              },
              "form": {
                "elements": [
                  {
                    "type": "text_field",
                    "item_code": "image_url",
                    "titles": {
                      "en": "Image URL",
                      "de": "Bild URL"
                    },
                    "is_output": false,
                    "is_mandatory": false
                  },
                  {
                    "type": "check_box",
                    "item_code": "rating",
                    "titles": {
                      "en": "How would you rate this?",
                      "de": "Wie w\u00fcrden Sie das bewerten?"
                    },
                    "is_output": true,
                    "is_mandatory": true,
                    "options": [
                      {
                        "code": "alternatives",
                        "value": [
                          {
                            "value": "good",
                            "titles": {
                              "en": "Good",
                              "de": "Gut"
                            }
                          },
                          {
                            "value": "bad",
                            "titles": {
                              "en": "Bad",
                              "de": "Schlecht"
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"task_template": {"code": "survey_template_002", "name": "My Survey Template", "titles": {"en": "Survey Title", "de": "Umfrage Titel"}, "descriptions": {"en": "Survey description", "de": "Beschreibung"}, "is_draft": false, "product": {"link": {"href": "{{baseUrlEndpoint}}/api/marketplace/v2/products/Survey", "rel": "product", "type": "application/json"}, "attributes": [{"code": "mp_df_survey_country", "value": ["US", "DE"]}, {"code": "mp_df_survey_payment", "value": 40}, {"code": "mp_df_survey_participants", "value": 3}, {"code": "mp_df_survey_age_from", "value": "18"}, {"code": "mp_df_survey_age_to", "value": "99"}, {"code": "mp_df_survey_gender", "value": "m"}, {"code": "mp_df_survey_expiration", "value": "2026-12-31"}, {"code": "mp_df_survey_language", "value": ["en", "de"]}]}, "form": {"elements": [{"type": "text_field", "item_code": "image_url", "titles": {"en": "Image URL", "de": "Bild URL"}, "is_output": false, "is_mandatory": false}, {"type": "check_box", "item_code": "rating", "titles": {"en": "How would you rate this?", "de": "Wie w\u00fcrden Sie das bewerten?"}, "is_output": true, "is_mandatory": true, "options": [{"code": "alternatives", "value": [{"value": "good", "titles": {"en": "Good", "de": "Gut"}}, {"value": "bad", "titles": {"en": "Bad", "de": "Schlecht"}}]}]}]}}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Post.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "task_template": {
              "code": "survey_template_002",
              "name": "My Survey Template",
              "titles": {
                "en": "Survey Title",
                "de": "Umfrage Titel"
              },
              "descriptions": {
                "en": "Survey description",
                "de": "Beschreibung"
              },
              "is_draft": false,
              "product": {
                "link": {
                  "href": "{{baseUrlEndpoint}}/api/marketplace/v2/products/Survey",
                  "rel": "product",
                  "type": "application/json"
                },
                "attributes": [
                  {
                    "code": "mp_df_survey_country",
                    "value": [
                      "US",
                      "DE"
                    ]
                  },
                  {
                    "code": "mp_df_survey_payment",
                    "value": 40
                  },
                  {
                    "code": "mp_df_survey_participants",
                    "value": 3
                  },
                  {
                    "code": "mp_df_survey_age_from",
                    "value": "18"
                  },
                  {
                    "code": "mp_df_survey_age_to",
                    "value": "99"
                  },
                  {
                    "code": "mp_df_survey_gender",
                    "value": "m"
                  },
                  {
                    "code": "mp_df_survey_expiration",
                    "value": "2026-12-31"
                  },
                  {
                    "code": "mp_df_survey_language",
                    "value": [
                      "en",
                      "de"
                    ]
                  }
                ]
              },
              "form": {
                "elements": [
                  {
                    "type": "text_field",
                    "item_code": "image_url",
                    "titles": {
                      "en": "Image URL",
                      "de": "Bild URL"
                    },
                    "is_output": false,
                    "is_mandatory": false
                  },
                  {
                    "type": "check_box",
                    "item_code": "rating",
                    "titles": {
                      "en": "How would you rate this?",
                      "de": "Wie w\u00fcrden Sie das bewerten?"
                    },
                    "is_output": true,
                    "is_mandatory": true,
                    "options": [
                      {
                        "code": "alternatives",
                        "value": [
                          {
                            "value": "good",
                            "titles": {
                              "en": "Good",
                              "de": "Gut"
                            }
                          },
                          {
                            "value": "bad",
                            "titles": {
                              "en": "Bad",
                              "de": "Schlecht"
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/task_templates/{templateCode}:
    get:
      tags:
      - Task Templates
      - Product Survey
      - Product Sentiment
      - Product iFrame
      summary: TaskTemplate.show
      description: |-
        ## TaskTemplate.show

        Returns the full definition of a task template including product attributes and form structure.
      operationId: tasktemplateshow
      parameters:
      - name: templateCode
        in: path
        required: true
        description: Your template code string
        schema:
          type: string
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
    put:
      tags:
      - Task Templates
      summary: TaskTemplate.update
      description: |-
        ## TaskTemplate.update

        Updates a task template's metadata.

        **Updatable fields:** `name`, `titles`, `descriptions`

        > **Note:** The `product` configuration and `form` structure **cannot be changed** after a template is created. If you need to alter the task structure, create a new template with a different code.
      operationId: tasktemplateupdate
      parameters:
      - name: templateCode
        in: path
        required: true
        description: Your template code string
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                task_template:
                  type: object
                  properties:
                    name:
                      type: string
                    titles:
                      type: object
                      properties:
                        en:
                          type: string
                        de:
                          type: string
                    descriptions:
                      type: object
                      properties:
                        en:
                          type: string
            example:
              task_template:
                name: Updated Name
                titles:
                  en: Updated Title
                  de: Aktualisierter Titel
                descriptions:
                  en: Updated description
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X PUT \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '
          {
            "task_template": {
              "name": "Updated Name",
              "titles": {
                "en": "Updated Title",
                "de": "Aktualisierter Titel"
              },
              "descriptions": {
                "en": "Updated description"
              }
            }
          }
          '
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "task_template": {
              "name": "Updated Name",
              "titles": {
                "en": "Updated Title",
                "de": "Aktualisierter Titel"
              },
              "descriptions": {
                "en": "Updated description"
              }
            }
          }

          response = requests.put(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}", {
            method: "PUT",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "task_template": {
              "name": "Updated Name",
              "titles": {
                "en": "Updated Title",
                "de": "Aktualisierter Titel"
              },
              "descriptions": {
                "en": "Updated description"
              }
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"task_template": {"name": "Updated Name", "titles": {"en": "Updated Title", "de": "Aktualisierter Titel"}, "descriptions": {"en": "Updated description"}}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Put.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "task_template": {
              "name": "Updated Name",
              "titles": {
                "en": "Updated Title",
                "de": "Aktualisierter Titel"
              },
              "descriptions": {
                "en": "Updated description"
              }
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
    delete:
      tags:
      - Task Templates
      summary: TaskTemplate.destroy
      description: |-
        ## TaskTemplate.destroy

        Deletes a task template.

        > **Important:** Deletion is only possible if **no tasks are currently using this template**. Archive or complete all associated tasks first.
      operationId: tasktemplatedestroy
      parameters:
      - name: templateCode
        in: path
        required: true
        description: Your template code string
        schema:
          type: string
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X DELETE \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.delete(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}", {
            method: "DELETE",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Delete.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/task_templates/{templateCode}/blacklist:
    put:
      tags:
      - Task Templates
      summary: TaskTemplate.blacklist
      description: |-
        ## TaskTemplate.blacklist

        Adds clickworkers to the blacklist for a specific template. Blacklisted workers will not be assigned tasks from this template.

        **Body fields:**

        | Field | Type | Description |
        |---|---|---|
        | `clickworker_ids` | array | Numeric clickworker user IDs to blacklist |
        | `valid_until` | string | Expiry date (YYYY-MM-DD); **omit for a permanent blacklist** |

        Useful for excluding workers who consistently submit low-quality results.
      operationId: tasktemplateblacklist
      parameters:
      - name: templateCode
        in: path
        required: true
        description: Your template code string
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                blacklist:
                  type: object
                  properties:
                    clickworker_ids:
                      type: array
                      items:
                        type: integer
                    valid_until:
                      type: string
            example:
              blacklist:
                clickworker_ids:
                - 12345
                - 67890
                valid_until: '2026-12-31'
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X PUT \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}/blacklist' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"blacklist": {"clickworker_ids": [12345, 67890], "valid_until": "2026-12-31"}}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}/blacklist"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "blacklist": {
              "clickworker_ids": [
                12345,
                67890
              ],
              "valid_until": "2026-12-31"
            }
          }

          response = requests.put(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}/blacklist", {
            method: "PUT",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "blacklist": {
              "clickworker_ids": [
                12345,
                67890
              ],
              "valid_until": "2026-12-31"
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}/blacklist");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"blacklist": {"clickworker_ids": [12345, 67890], "valid_until": "2026-12-31"}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/{templateCode}/blacklist")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Put.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "blacklist": {
              "clickworker_ids": [
                12345,
                67890
              ],
              "valid_until": "2026-12-31"
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/tasks:
    get:
      tags:
      - Tasks
      - Product Survey
      - Product Sentiment
      - Product iFrame
      summary: Tasks.index / Tasks.index (extended payload)
      description: |-
        ### Tasks.index

        ## Tasks.index

        Lists tasks with optional filters.

        **Filter parameters:**

        | Param | Description |
        |---|---|
        | `state` | `running`, `finished`, `timedout`, `cancelled`, `feedback` |
        | `from` / `to` | Creation date range (dd.mm.yyyy) |
        | `finished_from` / `finished_to` | Completion date range (dd.mm.yyyy) |
        | `task_template` | Filter by template code |
        | `order_id` | Filter by order ID |
        | `payload` | Set to `extended` to get inputs, results, notifications, and progress logs **inline** — avoids individual `show` calls |

        Use `payload=extended` when processing results in bulk.

        ---

        ### Tasks.index (extended payload)

        ## Tasks.index (extended payload)

        Fetches finished tasks with **full result data inline**. No need to call `Task.show` individually for each task.

        The response includes `input`, `result`, `notifications`, and `progress_logs` directly within each task object.

        Recommended for **bulk result collection** after a batch completes.
      operationId: tasksindex
      parameters:
      - name: _page_size
        in: query
        required: false
        description: Results per page
        schema:
          type: string
          example: '50'
      - name: _page_number
        in: query
        required: false
        description: Page number (1-based)
        schema:
          type: string
          example: '1'
      - name: state
        in: query
        required: false
        description: 'Filter: running, finished, timedout, cancelled, feedback'
        schema:
          type: string
      - name: from
        in: query
        required: false
        description: Created from date (dd.mm.yyyy)
        schema:
          type: string
      - name: to
        in: query
        required: false
        description: Created to date (dd.mm.yyyy)
        schema:
          type: string
      - name: finished_from
        in: query
        required: false
        description: Finished from date (dd.mm.yyyy)
        schema:
          type: string
      - name: finished_to
        in: query
        required: false
        description: Finished to date (dd.mm.yyyy)
        schema:
          type: string
      - name: task_template
        in: query
        required: false
        description: Filter by template code
        schema:
          type: string
      - name: order_id
        in: query
        required: false
        description: Filter by order ID
        schema:
          type: string
      - name: payload
        in: query
        required: false
        description: Set to 'extended' for full inline results
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              10_1_Tasks__running:
                summary: 10.1 Tasks (running)
                value:
                  task:
                    customer_ref: 037e4766-87a7-4c43-8637-aa37f57d6447
                    template:
                      link:
                        href: https://api-sandbox.clickworker.com/en/api/marketplace/v2/customer/task_templates/3221086a1cfb427d891dd993418feaae
                    input:
                      items:
                      - code: iframe_url
                        content: https://jeremy-johnson-survey-dev.herokuapp.com/037e4766-87a7-4c43-8637-aa37f57d6447
              10_2_Tasks__completed:
                summary: 10.2 Tasks (completed)
                value:
                  task:
                    customer_ref: 037e4766-87a7-4c43-8637-aa37f57d6447
                    template:
                      link:
                        href: https://api-sandbox.clickworker.com/en/api/marketplace/v2/customer/task_templates/3221086a1cfb427d891dd993418feaae
                    input:
                      items:
                      - code: iframe_url
                        content: https://jeremy-johnson-survey-dev.herokuapp.com/037e4766-87a7-4c43-8637-aa37f57d6447
              10_3_Tasks__timedout:
                summary: 10.3 Tasks (timedout)
                value:
                  task:
                    customer_ref: 037e4766-87a7-4c43-8637-aa37f57d6447
                    template:
                      link:
                        href: https://api-sandbox.clickworker.com/en/api/marketplace/v2/customer/task_templates/3221086a1cfb427d891dd993418feaae
                    input:
                      items:
                      - code: iframe_url
                        content: https://jeremy-johnson-survey-dev.herokuapp.com/037e4766-87a7-4c43-8637-aa37f57d6447
              10_4_Tasks__finished:
                summary: 10.4 Tasks (finished)
                value:
                  task:
                    customer_ref: 037e4766-87a7-4c43-8637-aa37f57d6447
                    template:
                      link:
                        href: https://api-sandbox.clickworker.com/en/api/marketplace/v2/customer/task_templates/3221086a1cfb427d891dd993418feaae
                    input:
                      items:
                      - code: iframe_url
                        content: https://jeremy-johnson-survey-dev.herokuapp.com/037e4766-87a7-4c43-8637-aa37f57d6447
              10_1_Tasks__running_2:
                summary: 10.1 Tasks (running)
                value:
                  task:
                    customer_ref: 037e4766-87a7-4c43-8637-aa37f57d6447
                    template:
                      link:
                        href: https://api-sandbox.clickworker.com/en/api/marketplace/v2/customer/task_templates/3221086a1cfb427d891dd993418feaae
                    input:
                      items:
                      - code: iframe_url
                        content: https://jeremy-johnson-survey-dev.herokuapp.com/037e4766-87a7-4c43-8637-aa37f57d6447
              10_2_Tasks__completed_2:
                summary: 10.2 Tasks (completed)
                value:
                  task:
                    customer_ref: 037e4766-87a7-4c43-8637-aa37f57d6447
                    template:
                      link:
                        href: https://api-sandbox.clickworker.com/en/api/marketplace/v2/customer/task_templates/3221086a1cfb427d891dd993418feaae
                    input:
                      items:
                      - code: iframe_url
                        content: https://jeremy-johnson-survey-dev.herokuapp.com/037e4766-87a7-4c43-8637-aa37f57d6447
              10_3_Tasks__timedout_2:
                summary: 10.3 Tasks (timedout)
                value:
                  task:
                    customer_ref: 037e4766-87a7-4c43-8637-aa37f57d6447
                    template:
                      link:
                        href: https://api-sandbox.clickworker.com/en/api/marketplace/v2/customer/task_templates/3221086a1cfb427d891dd993418feaae
                    input:
                      items:
                      - code: iframe_url
                        content: https://jeremy-johnson-survey-dev.herokuapp.com/037e4766-87a7-4c43-8637-aa37f57d6447
              10_4_Tasks__finished_2:
                summary: 10.4 Tasks (finished)
                value:
                  task:
                    customer_ref: 037e4766-87a7-4c43-8637-aa37f57d6447
                    template:
                      link:
                        href: https://api-sandbox.clickworker.com/en/api/marketplace/v2/customer/task_templates/3221086a1cfb427d891dd993418feaae
                    input:
                      items:
                      - code: iframe_url
                        content: https://jeremy-johnson-survey-dev.herokuapp.com/037e4766-87a7-4c43-8637-aa37f57d6447
              10_4_Tasks_Alegion:
                summary: 10.4 Tasks Alegion
                value:
                  task:
                    customer_ref: 037e4766-87a7-4c43-8637-aa37f57d6447
                    template:
                      link:
                        href: https://api-sandbox.clickworker.com/en/api/marketplace/v2/customer/task_templates/3221086a1cfb427d891dd993418feaae
                    input:
                      items:
                      - code: iframe_url
                        content: https://jeremy-johnson-survey-dev.herokuapp.com/037e4766-87a7-4c43-8637-aa37f57d6447
              10_1_Tasks__by_TaskTemplate:
                summary: 10.1 Tasks (by TaskTemplate)
                value:
                  task:
                    customer_ref: 037e4766-87a7-4c43-8637-aa37f57d6447
                    template:
                      link:
                        href: https://api-sandbox.clickworker.com/en/api/marketplace/v2/customer/task_templates/3221086a1cfb427d891dd993418feaae
                    input:
                      items:
                      - code: iframe_url
                        content: https://jeremy-johnson-survey-dev.herokuapp.com/037e4766-87a7-4c43-8637-aa37f57d6447
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks?_page_size=50&_page_number=1&state=state&from=from&to=to&finished_from=finished_from&finished_to=finished_to&task_template=task_template&order_id=order_id&payload=payload' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks"
          params = {
              "_page_size": "50",
              "_page_number": "1",
              "state": "",
              "from": "",
              "to": "",
              "finished_from": "",
              "finished_to": "",
              "task_template": "",
              "order_id": "",
              "payload": "",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              params=params,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks?_page_size=50&_page_number=1&state=state&from=from&to=to&finished_from=finished_from&finished_to=finished_to&task_template=task_template&order_id=order_id&payload=payload", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks?_page_size=50&_page_number=1&state=state&from=from&to=to&finished_from=finished_from&finished_to=finished_to&task_template=task_template&order_id=order_id&payload=payload");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks?_page_size=50&_page_number=1&state=state&from=from&to=to&finished_from=finished_from&finished_to=finished_to&task_template=task_template&order_id=order_id&payload=payload")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
    post:
      tags:
      - Tasks
      - Product Survey
      - Product Sentiment
      - Product iFrame
      summary: Task.create
      description: "## Task.create\n\nCreates a new task from an existing template. Tasks are **automatically confirmed**\
        \ and distributed to the crowd upon creation.\n\nFor specific examples of Task payload, check chapter \"11 Examples\"\
        .\n\n**Key body fields:**\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `customer_ref` | string | Your\
        \ internal reference (used for lookups via `Tasks.search`) |\n| `template.link` | object | Reference to the task template\
        \ by URL |\n| `input.items` | array | Per-task input data; `code` must match `item_code` fields in the template form\
        \ with `is_output: false` |\n| `notifications` | array | Webhook callbacks for task events (optional) |\n| `due_date`\
        \ | string | Optional due date (ISO 8601 datetime) for time-sensitive tasks |\n\n**Notification events:**\n\n- `TASK_COMPLETED`\
        \ — task finished with results\n    \n- `TASK_TIMEDOUT` — task expired without completion\n    \n- `CUSTOMER_INPUT_REQUIRED`\
        \ — buyoff approval needed from you\n    \n\n**Notification options:**  \nAdd `\"payload\": \"extended\"` to a notification\
        \ to receive the full task data (inputs + results) in the callback payload instead of just the task reference.\n\n\
        **Response:** Returns the created task with its ID, state, inputs, and pricing information. Store the task `id` for\
        \ subsequent `show` / `update` / `destroy` calls."
      operationId: taskcreate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              Task_create:
                summary: Task.create
                value:
                  task:
                    customer_ref: my_ref_001
                    due_date: '2026-12-31T23:59:59+00:00'
                    template:
                      link:
                      - href: '{{baseUrlEndpoint}}/api/marketplace/v2/customer/task_templates/{{templateCode}}'
                        rel: task_template
                        type: application/json
                    input:
                      items:
                      - code: image_url
                        content: https://example.com/image.jpg
                    notifications:
                    - event: TASK_COMPLETED
                      callback_url: https://your-server.com/notify
                      callback_method: POST
                      payload_format: JSON
                      payload: extended
                    - event: TASK_TIMEDOUT
                      callback_url: https://your-server.com/notify
                      callback_method: POST
                      payload_format: JSON
                    - event: CUSTOMER_INPUT_REQUIRED
                      callback_url: https://your-server.com/notify
                      callback_method: POST
                      payload_format: JSON
              07_3_Task_Create__w_Notification:
                summary: 07.3 Task Create (w Notification)
                value:
                  task:
                    customer_ref: survey_20210329_001
                    template:
                      link:
                      - href: https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/survey_20210329
                        rel: task_template
                        type: text/xml
                    input:
                      items:
                      - code: imageurl
                        content: https://cdn.clickworker.com/wp-content/uploads/2020/06/support-chatbot-training.jpeg
              07_3_Task_Create__Survey__Copy:
                summary: 07.3 Task Create (Survey) Copy
                value:
                  task:
                    customer_ref: survey_20250605
                    template:
                      link:
                      - href: https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/survey_20250605
                        rel: task_template
                        type: text/xml
                    notifications:
                    - callback_url: https://your-url.com
                      callback_method: POST
                      payload_format: JSON
                      event: TASK_COMPLETED
                      payload: extended
                    - callback_url: https://your-url.com
                      callback_method: POST
                      payload_format: JSON
                      event: TASK_TIMEDOUT
                    - callback_url: https://your-url.com
                      callback_method: POST
                      payload_format: JSON
                      event: CUSTOMER_INPUT_REQUIRED
                    input:
                      items:
                      - code: imageurl
                        content: https://cdn.clickworker.com/wp-content/uploads/2020/06/support-chatbot-training.jpeg
              07_3_Task_Create__Sentimet:
                summary: 07.3 Task Create (Sentimet)
                value:
                  task:
                    customer_ref: sentiment_20210329_001
                    template:
                      link:
                      - href: https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/sentiment_20210329
                        rel: task_template
                        type: text/xml
                    input:
                      items:
                      - code: photo_url
                        content: https://cdn.clickworker.com/wp-content/uploads/2021/03/shop-optimierung-tipps.png
              07_3_Task_Create__Sentimet__IAAI:
                summary: 07.3 Task Create (Sentimet) IAAI
                value:
                  task:
                    customer_ref: deaf80f0-a2ab-47b1-b5e2-2f4f96ee0945
                    template:
                      link:
                      - href: http://api-production.clickworker.com/api/marketplace/v2/customer/task_templates/62b5c3264525a083fcf0847bf1dee5bc543ec92f
                        rel: task_template
                        type: application/json
                    input:
                      items:
                      - code: customer_value1
                        content: '35635115'
                      - code: customer_value2
                        content: '3'
                      - code: customer_value3
                        content: '36107017'
                      - code: customer_value4
                        content: iaai
                      - code: content
                        content: https://vis.iaai.com/resizer?imageKeys=37358152~SID~I2&width=640&height=480
                      - code: cvgrade
                        content: '4'
              07_3_Task_Create__Alegion:
                summary: 07.3 Task Create (Alegion)
                value:
                  task:
                    customer_ref: task_123
                    template:
                      link:
                      - href: https://api-sandbox.clickworker.com/api/marketplace/v2/customer/task_templates/60f8e196451c8065adb5810fd4ed9d658647fda8
                        rel: task_template
                        type: text/json
                    input:
                      items:
                      - code: content
                        content: https://cdn.clickworker.com/wp-content/uploads/2021/03/shop-optimierung-tipps.png
              07_1_Task_Create__ExternalForm:
                summary: 07.1 Task Create (ExternalForm)
                value:
                  task:
                    customer_ref: '88808'
                    template:
                      link:
                        href: '{{baseUrlEndpoint}}/api/marketplace/v2/customer/task_templates/api_iframe_test_25_09_with_review'
                    input:
                      items:
                      - code: iframe_url
                        content: https://www.clickworker.com
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X POST \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '
          {
            "task": {
              "customer_ref": "my_ref_001",
              "due_date": "2026-12-31T23:59:59+00:00",
              "template": {
                "link": [
                  {
                    "href": "{{baseUrlEndpoint}}/api/marketplace/v2/customer/task_templates/{{templateCode}}",
                    "rel": "task_template",
                    "type": "application/json"
                  }
                ]
              },
              "input": {
                "items": [
                  {
                    "code": "image_url",
                    "content": "https://example.com/image.jpg"
                  }
                ]
              },
              "notifications": [
                {
                  "event": "TASK_COMPLETED",
                  "callback_url": "https://your-server.com/notify",
                  "callback_method": "POST",
                  "payload_format": "JSON",
                  "payload": "extended"
                },
                {
                  "event": "TASK_TIMEDOUT",
                  "callback_url": "https://your-server.com/notify",
                  "callback_method": "POST",
                  "payload_format": "JSON"
                },
                {
                  "event": "CUSTOMER_INPUT_REQUIRED",
                  "callback_url": "https://your-server.com/notify",
                  "callback_method": "POST",
                  "payload_format": "JSON"
                }
              ]
            }
          }
          '
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "task": {
              "customer_ref": "my_ref_001",
              "due_date": "2026-12-31T23:59:59+00:00",
              "template": {
                "link": [
                  {
                    "href": "{{baseUrlEndpoint}}/api/marketplace/v2/customer/task_templates/{{templateCode}}",
                    "rel": "task_template",
                    "type": "application/json"
                  }
                ]
              },
              "input": {
                "items": [
                  {
                    "code": "image_url",
                    "content": "https://example.com/image.jpg"
                  }
                ]
              },
              "notifications": [
                {
                  "event": "TASK_COMPLETED",
                  "callback_url": "https://your-server.com/notify",
                  "callback_method": "POST",
                  "payload_format": "JSON",
                  "payload": "extended"
                },
                {
                  "event": "TASK_TIMEDOUT",
                  "callback_url": "https://your-server.com/notify",
                  "callback_method": "POST",
                  "payload_format": "JSON"
                },
                {
                  "event": "CUSTOMER_INPUT_REQUIRED",
                  "callback_url": "https://your-server.com/notify",
                  "callback_method": "POST",
                  "payload_format": "JSON"
                }
              ]
            }
          }

          response = requests.post(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks", {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "task": {
              "customer_ref": "my_ref_001",
              "due_date": "2026-12-31T23:59:59+00:00",
              "template": {
                "link": [
                  {
                    "href": "{{baseUrlEndpoint}}/api/marketplace/v2/customer/task_templates/{{templateCode}}",
                    "rel": "task_template",
                    "type": "application/json"
                  }
                ]
              },
              "input": {
                "items": [
                  {
                    "code": "image_url",
                    "content": "https://example.com/image.jpg"
                  }
                ]
              },
              "notifications": [
                {
                  "event": "TASK_COMPLETED",
                  "callback_url": "https://your-server.com/notify",
                  "callback_method": "POST",
                  "payload_format": "JSON",
                  "payload": "extended"
                },
                {
                  "event": "TASK_TIMEDOUT",
                  "callback_url": "https://your-server.com/notify",
                  "callback_method": "POST",
                  "payload_format": "JSON"
                },
                {
                  "event": "CUSTOMER_INPUT_REQUIRED",
                  "callback_url": "https://your-server.com/notify",
                  "callback_method": "POST",
                  "payload_format": "JSON"
                }
              ]
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"task": {"customer_ref": "my_ref_001", "due_date": "2026-12-31T23:59:59+00:00", "template": {"link": [{"href": "{{baseUrlEndpoint}}/api/marketplace/v2/customer/task_templates/{{templateCode}}", "rel": "task_template", "type": "application/json"}]}, "input": {"items": [{"code": "image_url", "content": "https://example.com/image.jpg"}]}, "notifications": [{"event": "TASK_COMPLETED", "callback_url": "https://your-server.com/notify", "callback_method": "POST", "payload_format": "JSON", "payload": "extended"}, {"event": "TASK_TIMEDOUT", "callback_url": "https://your-server.com/notify", "callback_method": "POST", "payload_format": "JSON"}, {"event": "CUSTOMER_INPUT_REQUIRED", "callback_url": "https://your-server.com/notify", "callback_method": "POST", "payload_format": "JSON"}]}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Post.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "task": {
              "customer_ref": "my_ref_001",
              "due_date": "2026-12-31T23:59:59+00:00",
              "template": {
                "link": [
                  {
                    "href": "{{baseUrlEndpoint}}/api/marketplace/v2/customer/task_templates/{{templateCode}}",
                    "rel": "task_template",
                    "type": "application/json"
                  }
                ]
              },
              "input": {
                "items": [
                  {
                    "code": "image_url",
                    "content": "https://example.com/image.jpg"
                  }
                ]
              },
              "notifications": [
                {
                  "event": "TASK_COMPLETED",
                  "callback_url": "https://your-server.com/notify",
                  "callback_method": "POST",
                  "payload_format": "JSON",
                  "payload": "extended"
                },
                {
                  "event": "TASK_TIMEDOUT",
                  "callback_url": "https://your-server.com/notify",
                  "callback_method": "POST",
                  "payload_format": "JSON"
                },
                {
                  "event": "CUSTOMER_INPUT_REQUIRED",
                  "callback_url": "https://your-server.com/notify",
                  "callback_method": "POST",
                  "payload_format": "JSON"
                }
              ]
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/tasks/search:
    get:
      tags:
      - Tasks
      summary: Tasks.search
      description: |-
        ## Tasks.search

        Search tasks by `customer_ref` — the internal reference you set when creating tasks.

        This is the recommended way to look up a task using **your own identifiers** without knowing the API task ID.
      operationId: taskssearch
      parameters:
      - name: customer_ref
        in: query
        required: false
        description: Your internal reference string set at task creation
        schema:
          type: string
          example: my_ref_001
      - name: state
        in: query
        required: false
        description: Optional state filter
        schema:
          type: string
      - name: _page_size
        in: query
        required: false
        schema:
          type: string
          example: '50'
      - name: _page_number
        in: query
        required: false
        schema:
          type: string
          example: '1'
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/search?customer_ref=my_ref_001&state=state&_page_size=50&_page_number=1' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/search"
          params = {
              "customer_ref": "my_ref_001",
              "state": "",
              "_page_size": "50",
              "_page_number": "1",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              params=params,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/search?customer_ref=my_ref_001&state=state&_page_size=50&_page_number=1", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/search?customer_ref=my_ref_001&state=state&_page_size=50&_page_number=1");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/search?customer_ref=my_ref_001&state=state&_page_size=50&_page_number=1")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/tasks/{taskId}:
    get:
      tags:
      - Tasks
      - Product Survey
      - Product Sentiment
      - Product iFrame
      summary: Task.show
      description: |-
        ## Task.show

        Returns full details for a single task including current state, input, and results (if completed).

        **Query params:**
        - `show_cloned_task` (boolean) — include cloned task data in the response if the task was cloned
      operationId: taskshow
      parameters:
      - name: taskId
        in: path
        required: true
        description: Numeric task ID
        schema:
          type: string
      - name: show_cloned_task
        in: query
        required: false
        description: Set to true to show cloned task data if present
        schema:
          type: string
          example: 'false'
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}?show_cloned_task=false' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}"
          params = {
              "show_cloned_task": "false",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              params=params,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}?show_cloned_task=false", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}?show_cloned_task=false");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}?show_cloned_task=false")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
    put:
      tags:
      - Tasks
      - Product Survey
      - Product Sentiment
      - Product iFrame
      summary: Task.update (confirm) / Task.expire
      description: |-
        ### Task.update (confirm)

        ## Task.update (confirm)

        Explicitly confirms a task. Most tasks are auto-confirmed at creation, but if a task is in `unconfirmed` state (e.g. due to insufficient balance at creation time), use this to release it to the crowd.

        Only two state transitions are supported via this endpoint:
        - `confirmed` — confirm and release to crowd
        - `expired` — force-expire the task (see `Task.expire`)

        Returns `409 Conflict` if the state transition is not valid for the task's current state.

        > **Tip:** Add `_suppress_http_status=1` as a query param to always receive HTTP 200, and check the `request_status` field in the response body to determine success or failure.

        ---

        ### Task.expire

        ## Task.expire

        Force-expires a task, setting it to a timed-out state. Use this to cancel active tasks that are no longer needed.
      operationId: taskupdateConfirm
      parameters:
      - name: taskId
        in: path
        required: true
        description: Numeric task ID
        schema:
          type: string
      - name: _suppress_http_status
        in: query
        required: false
        description: 'Optional: always return HTTP 200; check request_status in body instead'
        schema:
          type: string
          example: '1'
      - name: state
        in: query
        required: false
        schema:
          type: string
          example: expired
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              Task_update__confirm:
                summary: Task.update (confirm)
                value:
                  task:
                    state: confirmed
              Task_expire:
                summary: Task.expire
                value:
                  task:
                    state: expired
              12_Tasks_Expire:
                summary: 12 Tasks Expire
                value:
                  task:
                    state: expired
              12_Tasks_Expire_2:
                summary: 12 Tasks Expire
                value:
                  task:
                    state: expired
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X PUT \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}?_suppress_http_status=1&state=expired' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"task": {"state": "confirmed"}}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}"
          params = {
              "_suppress_http_status": "1",
              "state": "expired",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "task": {
              "state": "confirmed"
            }
          }

          response = requests.put(
              url,
              params=params,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}?_suppress_http_status=1&state=expired", {
            method: "PUT",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "task": {
              "state": "confirmed"
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}?_suppress_http_status=1&state=expired");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"task": {"state": "confirmed"}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}?_suppress_http_status=1&state=expired")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Put.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "task": {
              "state": "confirmed"
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
    delete:
      tags:
      - Tasks
      summary: Task.destroy
      description: |-
        ## Task.destroy

        Marks a task as deleted. Any jobs in `new`, `assigned`, or `reserved` state are automatically cancelled.

        Completed tasks are marked deleted but their results remain accessible.
      operationId: taskdestroy
      parameters:
      - name: taskId
        in: path
        required: true
        description: Numeric task ID
        schema:
          type: string
      - name: _suppress_http_status
        in: query
        required: false
        description: 'Optional: always return HTTP 200; check request_status in body instead'
        schema:
          type: string
          example: '1'
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X DELETE \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}?_suppress_http_status=1' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}"
          params = {
              "_suppress_http_status": "1",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.delete(
              url,
              params=params,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}?_suppress_http_status=1", {
            method: "DELETE",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}?_suppress_http_status=1");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}?_suppress_http_status=1")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Delete.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/tasks/{taskId}/grant_bonus:
    post:
      tags:
      - Tasks
      - Product Survey
      - Product iFrame
      summary: Task.grant_bonus
      description: |-
        ## Task.grant_bonus

        Grants an additional bonus payment to a specific clickworker for their work on a task.

        **Body fields:**

        | Field | Type | Description |
        | --- | --- | --- |
        | `amount` | number | Bonus amount in your account currency |
        | `clickworker_id` | integer | The clickworker's user ID |
        | `comment` | string | Optional message shown to the worker |

        > **Note:** Typically, a **40% surcharge** is added to the bonus amount on top of the basic payment surcharge.
      operationId: taskgrant_bonus
      parameters:
      - name: taskId
        in: path
        required: true
        description: Numeric task ID
        schema:
          type: string
      - name: state
        in: query
        required: false
        schema:
          type: string
          example: expired
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              Task_grant_bonus:
                summary: Task.grant_bonus
                value:
                  bonus:
                    amount: 0.5
                    clickworker_id: 12345
                    comment: Great work!
              13_Task_Grant_Bonus:
                summary: 13 Task Grant Bonus
                value:
                  bonus:
                    amount: 0.1
                    clickworker_id: 14381263
                    comment: Good job!
              13_Tasks_Grant_Bonus:
                summary: 13 Tasks Grant Bonus
                value:
                  bonus:
                    amount: 0.1
                    clickworker_id: 14381263
                    comment: Good job!
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X POST \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/grant_bonus?state=expired' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"bonus": {"amount": 0.5, "clickworker_id": 12345, "comment": "Great work!"}}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/grant_bonus"
          params = {
              "state": "expired",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "bonus": {
              "amount": 0.5,
              "clickworker_id": 12345,
              "comment": "Great work!"
            }
          }

          response = requests.post(
              url,
              params=params,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/grant_bonus?state=expired", {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "bonus": {
              "amount": 0.5,
              "clickworker_id": 12345,
              "comment": "Great work!"
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/grant_bonus?state=expired");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"bonus": {"amount": 0.5, "clickworker_id": 12345, "comment": "Great work!"}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/grant_bonus?state=expired")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Post.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "bonus": {
              "amount": 0.5,
              "clickworker_id": 12345,
              "comment": "Great work!"
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/tasks/{taskId}/external_submit:
    post:
      tags:
      - Tasks
      summary: Task.external_submit (by clickworker)
      description: |-
        ## Task.external_submit (by clickworker)

        Submits results for a task on behalf of a clickworker. Used with **ExternalForm** tasks where submission happens through your own platform.

        **Requirements:**
        - `clickworker_id` must be provided
        - The task must have an assigned `GuiJob` in `running` or `timedout` state

        Use this when you know the clickworker's ID but not the specific job ID.
      operationId: taskexternal_submitByClickworker
      parameters:
      - name: taskId
        in: path
        required: true
        description: Numeric task ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                clickworker_id:
                  type: integer
                submit:
                  type: object
                  properties:
                    result:
                      type: string
            example:
              clickworker_id: 12345
              submit:
                result: Submitted answer
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X POST \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/external_submit' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"clickworker_id": 12345, "submit": {"result": "Submitted answer"}}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/external_submit"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "clickworker_id": 12345,
            "submit": {
              "result": "Submitted answer"
            }
          }

          response = requests.post(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/external_submit", {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "clickworker_id": 12345,
            "submit": {
              "result": "Submitted answer"
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/external_submit");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"clickworker_id": 12345, "submit": {"result": "Submitted answer"}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/external_submit")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Post.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "clickworker_id": 12345,
            "submit": {
              "result": "Submitted answer"
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/tasks/{taskId}/external_submit/{jobId}:
    post:
      tags:
      - Tasks
      - Product Survey
      - Product iFrame
      summary: Task.external_submit (by job ID)
      description: |-
        ## Task.external_submit (by job ID)

        Submits results for a specific job by its ID. Use this variant when you have the exact job ID from a notification or prior API response.
      operationId: taskexternal_submitByJobId
      parameters:
      - name: taskId
        in: path
        required: true
        description: Numeric task ID
        schema:
          type: string
      - name: jobId
        in: path
        required: true
        description: Numeric job ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              Task_external_submit__by_job_ID:
                summary: Task.external_submit (by job ID)
                value:
                  submit:
                    result: Submitted answer
              08_Send_Postback__for_external_submit:
                summary: 08 Send Postback (for external submit)
                value: {}
              08_Send_Postback:
                summary: 08 Send Postback
                value: {}
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X POST \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/external_submit/{jobId}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"submit": {"result": "Submitted answer"}}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/external_submit/{jobId}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "submit": {
              "result": "Submitted answer"
            }
          }

          response = requests.post(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/external_submit/{jobId}", {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "submit": {
              "result": "Submitted answer"
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/external_submit/{jobId}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"submit": {"result": "Submitted answer"}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/external_submit/{jobId}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Post.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "submit": {
              "result": "Submitted answer"
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/tasks/{taskId}/accept:
    put:
      tags:
      - Tasks
      summary: Task.accept (buyoff approve)
      description: |-
        ## Task.accept (buyoff approve)

        Approves the buyoff for a task awaiting customer review (`CUSTOMER_INPUT_REQUIRED` event).

        Call this when you are satisfied with the worker's submission. Payment is released to the clickworker after acceptance.

        To target a specific job within the task, append `/{{jobId}}` to the URL or use `Task.accept (buyoff approve by job)`.
      operationId: taskacceptBuyoffApprove
      parameters:
      - name: taskId
        in: path
        required: true
        description: Numeric task ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties: {}
            example: {}
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X PUT \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/accept' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/accept"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {}

          response = requests.put(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/accept", {
            method: "PUT",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({}),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/accept");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/accept")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Put.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {}.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/tasks/{taskId}/accept/{jobId}:
    put:
      tags:
      - Tasks
      - Product iFrame
      summary: Task.accept (buyoff approve by job)
      description: |-
        ## Task.accept (buyoff approve by job)

        Approves the buyoff for a **specific job ID** within a task. Use when you have the exact job ID from a `CUSTOMER_INPUT_REQUIRED` notification.
      operationId: taskacceptBuyoffApproveByJob
      parameters:
      - name: taskId
        in: path
        required: true
        description: Numeric task ID
        schema:
          type: string
      - name: jobId
        in: path
        required: true
        description: Numeric job ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              Task_accept__buyoff_approve_by_job:
                summary: Task.accept (buyoff approve by job)
                value: {}
              09_1_Review__Approve:
                summary: 09.1 Review (Approve)
                value:
                  accept:
                    description: Well done!
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X PUT \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/accept/{jobId}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/accept/{jobId}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {}

          response = requests.put(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/accept/{jobId}", {
            method: "PUT",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({}),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/accept/{jobId}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/accept/{jobId}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Put.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {}.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/tasks/{taskId}/reject:
    put:
      tags:
      - Tasks
      summary: Task.reject (buyoff reject)
      description: |-
        ## Task.reject (buyoff reject)

        Rejects the buyoff for a task.

        **Body fields:**

        | Field | Type | Description |
        |---|---|---|
        | `description` | string | **Required.** Reason for rejection shown to the worker |
        | `allow_edit` | boolean | `true` = soft reject (worker can revise); `false` = hard reject (task returned to pool) |

        **Rejection modes:**
        - **Soft reject** (`allow_edit: true`) — the result is sent back to the same worker for revision
        - **Hard reject** (`allow_edit: false`) — the task is rejected and reassigned to a new worker
      operationId: taskrejectBuyoffReject
      parameters:
      - name: taskId
        in: path
        required: true
        description: Numeric task ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                reject:
                  type: object
                  properties:
                    description:
                      type: string
                    allow_edit:
                      type: boolean
            example:
              reject:
                description: The result does not meet requirements
                allow_edit: false
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X PUT \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/reject' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '
          {
            "reject": {
              "description": "The result does not meet requirements",
              "allow_edit": false
            }
          }
          '
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/reject"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "reject": {
              "description": "The result does not meet requirements",
              "allow_edit": false
            }
          }

          response = requests.put(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/reject", {
            method: "PUT",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "reject": {
              "description": "The result does not meet requirements",
              "allow_edit": false
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/reject");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"reject": {"description": "The result does not meet requirements", "allow_edit": false}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/reject")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Put.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "reject": {
              "description": "The result does not meet requirements",
              "allow_edit": false
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/tasks/{taskId}/reject/{jobId}:
    put:
      tags:
      - Tasks
      - Product iFrame
      summary: Task.reject (buyoff reject by job)
      description: |-
        ## Task.reject (buyoff reject by job)

        Rejects the buyoff for a **specific job ID** within a task. Use `allow_edit: true` to send back for revision (soft reject) or `allow_edit: false` for a hard reject.
      operationId: taskrejectBuyoffRejectByJob
      parameters:
      - name: taskId
        in: path
        required: true
        description: Numeric task ID
        schema:
          type: string
      - name: jobId
        in: path
        required: true
        description: Numeric job ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              Task_reject__buyoff_reject_by_job:
                summary: Task.reject (buyoff reject by job)
                value:
                  reject:
                    description: Please revise the image classification
                    allow_edit: true
              09_2_Review__Reject:
                summary: 09.2 Review (Reject)
                value:
                  reject:
                    description: Sorry, but your answer was incorrect
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X PUT \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/reject/{jobId}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '
          {
            "reject": {
              "description": "Please revise the image classification",
              "allow_edit": true
            }
          }
          '
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/reject/{jobId}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "reject": {
              "description": "Please revise the image classification",
              "allow_edit": true
            }
          }

          response = requests.put(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/reject/{jobId}", {
            method: "PUT",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "reject": {
              "description": "Please revise the image classification",
              "allow_edit": true
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/reject/{jobId}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"reject": {"description": "Please revise the image classification", "allow_edit": true}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/reject/{jobId}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Put.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "reject": {
              "description": "Please revise the image classification",
              "allow_edit": true
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/teams:
    get:
      tags:
      - Teams
      summary: Teams.index
      description: |-
        ## Teams.index

        Lists all teams for your account.

        **Pagination parameters:**
        - `_page_size` — number of results per page (default 50, max 50)
        - `_page_number` — page number to retrieve (1-based)
      operationId: teamsindex
      parameters:
      - name: _page_size
        in: query
        required: false
        description: Results per page (max 50)
        schema:
          type: string
          example: '50'
      - name: _page_number
        in: query
        required: false
        description: Page number (1-based)
        schema:
          type: string
          example: '1'
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams?_page_size=50&_page_number=1' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams"
          params = {
              "_page_size": "50",
              "_page_number": "1",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              params=params,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams?_page_size=50&_page_number=1", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams?_page_size=50&_page_number=1");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams?_page_size=50&_page_number=1")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
    post:
      tags:
      - Teams
      summary: Teams.create
      description: |-
        ## Teams.create

        Creates a new team.

        **Body fields:**

        | Field | Type | Description |
        |---|---|---|
        | `name` | string | **Required.** Team name |
        | `note` | string | Optional description/notes |
        | `hide` | boolean | Hide team from public listings |

        After creating, use `Teams.update` to add clickworkers by their user IDs.
      operationId: teamscreate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                team:
                  type: object
                  properties:
                    name:
                      type: string
                    note:
                      type: string
                    hide:
                      type: boolean
            example:
              team:
                name: My Team
                note: Team description
                hide: false
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X POST \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"team": {"name": "My Team", "note": "Team description", "hide": false}}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "team": {
              "name": "My Team",
              "note": "Team description",
              "hide": false
            }
          }

          response = requests.post(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams", {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "team": {
              "name": "My Team",
              "note": "Team description",
              "hide": false
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"team": {"name": "My Team", "note": "Team description", "hide": false}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Post.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "team": {
              "name": "My Team",
              "note": "Team description",
              "hide": false
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/teams/{teamId}:
    get:
      tags:
      - Teams
      summary: Teams.show
      description: |-
        ## Teams.show

        Returns details for a specific team including its member list.

        Replace `{{teamId}}` with the numeric ID returned when creating the team.
      operationId: teamsshow
      parameters:
      - name: teamId
        in: path
        required: true
        description: Numeric team ID
        schema:
          type: string
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
    put:
      tags:
      - Teams
      summary: Teams.update
      description: |-
        ## Teams.update

        Updates a team's metadata and/or membership.

        **Body fields:**

        | Field | Type | Description |
        |---|---|---|
        | `name` | string | New team name |
        | `note` | string | Updated description |
        | `hide` | boolean | Hide team from public listings |
        | `add_user_ids` | array | Clickworker user IDs to **add** to the team |
        | `remove_user_ids` | array | Clickworker user IDs to **remove** from the team |

        You can add and remove members in a single request.
      operationId: teamsupdate
      parameters:
      - name: teamId
        in: path
        required: true
        description: Numeric team ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                team:
                  type: object
                  properties:
                    name:
                      type: string
                    note:
                      type: string
                    hide:
                      type: boolean
                    add_user_ids:
                      type: array
                      items:
                        type: integer
                    remove_user_ids:
                      type: array
                      items:
                        type: integer
            example:
              team:
                name: Updated Team
                note: Updated note
                hide: false
                add_user_ids:
                - 123
                - 456
                remove_user_ids:
                - 789
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X PUT \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '
          {
            "team": {
              "name": "Updated Team",
              "note": "Updated note",
              "hide": false,
              "add_user_ids": [
                123,
                456
              ],
              "remove_user_ids": [
                789
              ]
            }
          }
          '
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "team": {
              "name": "Updated Team",
              "note": "Updated note",
              "hide": false,
              "add_user_ids": [
                123,
                456
              ],
              "remove_user_ids": [
                789
              ]
            }
          }

          response = requests.put(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}", {
            method: "PUT",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "team": {
              "name": "Updated Team",
              "note": "Updated note",
              "hide": false,
              "add_user_ids": [
                123,
                456
              ],
              "remove_user_ids": [
                789
              ]
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"team": {"name": "Updated Team", "note": "Updated note", "hide": false, "add_user_ids": [123, 456], "remove_user_ids": [789]}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Put.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "team": {
              "name": "Updated Team",
              "note": "Updated note",
              "hide": false,
              "add_user_ids": [
                123,
                456
              ],
              "remove_user_ids": [
                789
              ]
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
    delete:
      tags:
      - Teams
      summary: Teams.destroy
      description: |-
        ## Teams.destroy

        Permanently deletes a team.

        > **Warning:** This action cannot be undone. Ensure no active task templates are targeting this team before deleting.
      operationId: teamsdestroy
      parameters:
      - name: teamId
        in: path
        required: true
        description: Numeric team ID
        schema:
          type: string
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X DELETE \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.delete(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}", {
            method: "DELETE",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/teams/{teamId}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Delete.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/jobs:
    get:
      tags:
      - Jobs
      summary: Jobs.index
      description: |-
        ## Jobs.index

        Lists all jobs assigned to the customer account. These are typically **buyoff/signoff jobs** awaiting your review.

        Filter by `task_id` to scope results to a specific task.
      operationId: jobsindex
      parameters:
      - name: _page_size
        in: query
        required: false
        schema:
          type: string
          example: '50'
      - name: _page_number
        in: query
        required: false
        schema:
          type: string
          example: '1'
      - name: task_id
        in: query
        required: false
        description: 'Optional: filter jobs by task ID'
        schema:
          type: string
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs?_page_size=50&_page_number=1&task_id=task_id' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs"
          params = {
              "_page_size": "50",
              "_page_number": "1",
              "task_id": "",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              params=params,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs?_page_size=50&_page_number=1&task_id=task_id", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs?_page_size=50&_page_number=1&task_id=task_id");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs?_page_size=50&_page_number=1&task_id=task_id")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/tasks/{taskId}/jobs:
    get:
      tags:
      - Jobs
      summary: Jobs.index (by task)
      description: |-
        ## Jobs.index (by task)

        Lists all jobs for a specific task. Useful for seeing all worker assignments and their current states for a given task.
      operationId: jobsindexByTask
      parameters:
      - name: taskId
        in: path
        required: true
        description: Numeric task ID
        schema:
          type: string
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/jobs' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/jobs"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/jobs", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/jobs");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/jobs")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/jobs/{jobId}:
    get:
      tags:
      - Jobs
      - Product Survey
      summary: Job.show
      description: |-
        ## Job.show

        Returns full details for a single job including the form definition and current item values submitted by the worker.
      operationId: jobshow
      parameters:
      - name: jobId
        in: path
        required: true
        description: Numeric job ID
        schema:
          type: string
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
    put:
      tags:
      - Jobs
      summary: Job.update
      description: |-
        ## Job.update

        Submits customer review/buyoff input for a job.

        The `input.items` must match the **form definition** of the job — use `Job.show` to inspect the expected field codes.

        Common buyoff form fields:
        - `accepted` — approval flag (e.g. `"1"` for yes, `"0"` for no)
        - `grade_gr` — quality grade
        - `comment` — reviewer comment sent to the worker
      operationId: jobupdate
      parameters:
      - name: jobId
        in: path
        required: true
        description: Numeric job ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                job:
                  type: object
                  properties:
                    input:
                      type: object
                      properties:
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              code:
                                type: string
                              content:
                                type: string
            example:
              job:
                input:
                  items:
                  - code: accepted
                    content: '1'
                  - code: grade_gr
                    content: '2'
                  - code: comment
                    content: Well written text
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X PUT \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '
          {
            "job": {
              "input": {
                "items": [
                  {
                    "code": "accepted",
                    "content": "1"
                  },
                  {
                    "code": "grade_gr",
                    "content": "2"
                  },
                  {
                    "code": "comment",
                    "content": "Well written text"
                  }
                ]
              }
            }
          }
          '
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "job": {
              "input": {
                "items": [
                  {
                    "code": "accepted",
                    "content": "1"
                  },
                  {
                    "code": "grade_gr",
                    "content": "2"
                  },
                  {
                    "code": "comment",
                    "content": "Well written text"
                  }
                ]
              }
            }
          }

          response = requests.put(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}", {
            method: "PUT",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "job": {
              "input": {
                "items": [
                  {
                    "code": "accepted",
                    "content": "1"
                  },
                  {
                    "code": "grade_gr",
                    "content": "2"
                  },
                  {
                    "code": "comment",
                    "content": "Well written text"
                  }
                ]
              }
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"job": {"input": {"items": [{"code": "accepted", "content": "1"}, {"code": "grade_gr", "content": "2"}, {"code": "comment", "content": "Well written text"}]}}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Put.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "job": {
              "input": {
                "items": [
                  {
                    "code": "accepted",
                    "content": "1"
                  },
                  {
                    "code": "grade_gr",
                    "content": "2"
                  },
                  {
                    "code": "comment",
                    "content": "Well written text"
                  }
                ]
              }
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/jobs/{jobId}/external_submit:
    post:
      tags:
      - Jobs
      - Product Survey
      summary: Job.external_submit (by job ID)
      description: |-
        ## Job.external_submit (by job ID)

        External submit for a specific job via the jobs route. Use when you have the job ID directly.
      operationId: jobexternal_submitByJobId
      parameters:
      - name: jobId
        in: path
        required: true
        description: Numeric job ID
        schema:
          type: string
      - name: ''
        in: query
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              Job_external_submit__by_job_ID:
                summary: Job.external_submit (by job ID)
                value:
                  submit:
                    result: answer
              08_Send_Postback__via_JobID:
                summary: 08 Send Postback (via JobID)
                value: {}
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X POST \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}/external_submit?=' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"submit": {"result": "answer"}}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}/external_submit"
          params = {
              "": "",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "submit": {
              "result": "answer"
            }
          }

          response = requests.post(
              url,
              params=params,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}/external_submit?=", {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "submit": {
              "result": "answer"
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}/external_submit?=");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"submit": {"result": "answer"}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/{jobId}/external_submit?=")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Post.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "submit": {
              "result": "answer"
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/jobs/external_submit/{jobId}:
    post:
      tags:
      - Jobs
      - Product Survey
      summary: Job.external_submit (alt route)
      description: |-
        ## Job.external_submit (alt route)

        Alternative external submit path (legacy route). Functionally equivalent to `Job.external_submit (by job ID)` but uses a different URL pattern.
      operationId: jobexternal_submitAltRoute
      parameters:
      - name: jobId
        in: path
        required: true
        description: Numeric job ID
        schema:
          type: string
      - name: ''
        in: query
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              Job_external_submit__alt_route:
                summary: Job.external_submit (alt route)
                value:
                  submit:
                    result: answer
              08_Send_Postback__via_JobID__Copy:
                summary: 08 Send Postback (via JobID) Copy
                value: {}
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X POST \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/external_submit/{jobId}?=' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"submit": {"result": "answer"}}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/external_submit/{jobId}"
          params = {
              "": "",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "submit": {
              "result": "answer"
            }
          }

          response = requests.post(
              url,
              params=params,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/external_submit/{jobId}?=", {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "submit": {
              "result": "answer"
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/external_submit/{jobId}?=");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"submit": {"result": "answer"}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/jobs/external_submit/{jobId}?=")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Post.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "submit": {
              "result": "answer"
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/notifications:
    get:
      tags:
      - Notifications
      summary: Notifications.index
      description: |-
        ## Notifications.index

        Lists all notification registrations for the customer account.
      operationId: notificationsindex
      parameters:
      - name: _page_size
        in: query
        required: false
        schema:
          type: string
          example: '50'
      - name: _page_number
        in: query
        required: false
        schema:
          type: string
          example: '1'
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/notifications?_page_size=50&_page_number=1' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/notifications"
          params = {
              "_page_size": "50",
              "_page_number": "1",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              params=params,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/notifications?_page_size=50&_page_number=1", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/notifications?_page_size=50&_page_number=1");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/notifications?_page_size=50&_page_number=1")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/tasks/{taskId}/notifications:
    get:
      tags:
      - Notifications
      summary: Notifications.index (by task)
      description: |-
        ## Notifications.index (by task)

        Lists all notification registrations for a specific task.
      operationId: notificationsindexByTask
      parameters:
      - name: taskId
        in: path
        required: true
        description: Numeric task ID
        schema:
          type: string
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/notifications' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/notifications"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/notifications", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/notifications");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/tasks/{taskId}/notifications")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/notification_listener/log:
    post:
      tags:
      - Notifications
      summary: NotificationListener.log
      description: |-
        ## NotificationListener.log

        A webhook endpoint for **logging notification callbacks**. No authentication required.

        This is the endpoint you configure as `callback_url` when creating task notifications. Configure your own server to handle these POSTs in production, but you can point this to a tool like [webhook.site](https://webhook.site) or [RequestBin](https://requestbin.com) during development.

        **No authentication required** — the endpoint is publicly accessible.
      operationId: notificationlistenerlog
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                event:
                  type: string
                task:
                  type: object
                  properties:
                    id:
                      type: integer
            example:
              event: TASK_COMPLETED
              task:
                id: 12345
      security: []
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X POST \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/notification_listener/log' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"event": "TASK_COMPLETED", "task": {"id": 12345}}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/notification_listener/log"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          payload = {
            "event": "TASK_COMPLETED",
            "task": {
              "id": 12345
            }
          }

          response = requests.post(
              url,
              headers=headers,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/notification_listener/log", {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
            },
            body: JSON.stringify({
            "event": "TASK_COMPLETED",
            "task": {
              "id": 12345
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/notification_listener/log");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"event": "TASK_COMPLETED", "task": {"id": 12345}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/notification_listener/log")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Post.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.body = {
            "event": "TASK_COMPLETED",
            "task": {
              "id": 12345
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/clickworkers:
    get:
      tags:
      - Clickworkers
      summary: Clickworkers.count_in_range / Clickworkers.count_in_bounding_box
      description: |-
        ### Clickworkers.count_in_range

        ## Clickworkers.count_in_range

        Counts clickworkers within a circular radius around a center point.

        **Parameters:**
        - `latitude` / `longitude` — center of the search area
        - `radius` — search radius in **km** (minimum 10km)

        **Response:** `{ "clickworker_count": 1234 }`

        Useful for validating that enough workers exist in a geographic area before launching location-specific tasks.

        ---

        ### Clickworkers.count_in_bounding_box

        ## Clickworkers.count_in_bounding_box

        Counts clickworkers within a rectangular geographic bounding box.

        Define the box using south-west (`sw_`) and north-east (`ne_`) corner coordinates. The example covers roughly Germany and surrounding areas.
      operationId: clickworkerscount_in_range
      parameters:
      - name: api_method
        in: query
        required: false
        schema:
          type: string
          example: count_in_range
      - name: latitude
        in: query
        required: false
        description: Center latitude (London example)
        schema:
          type: string
          example: '51.5074'
      - name: longitude
        in: query
        required: false
        description: Center longitude (London example)
        schema:
          type: string
          example: '-0.1278'
      - name: radius
        in: query
        required: false
        description: Radius in km (minimum 10)
        schema:
          type: string
          example: '50'
      - name: sw_latitude
        in: query
        required: false
        description: South-west corner latitude
        schema:
          type: string
          example: '48.0'
      - name: sw_longitude
        in: query
        required: false
        description: South-west corner longitude
        schema:
          type: string
          example: '8.0'
      - name: ne_latitude
        in: query
        required: false
        description: North-east corner latitude
        schema:
          type: string
          example: '54.0'
      - name: ne_longitude
        in: query
        required: false
        description: North-east corner longitude
        schema:
          type: string
          example: '15.0'
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers?api_method=count_in_range&latitude=51.5074&longitude=-0.1278&radius=50&sw_latitude=48.0&sw_longitude=8.0&ne_latitude=54.0&ne_longitude=15.0' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers"
          params = {
              "api_method": "count_in_range",
              "latitude": "51.5074",
              "longitude": "-0.1278",
              "radius": "50",
              "sw_latitude": "48.0",
              "sw_longitude": "8.0",
              "ne_latitude": "54.0",
              "ne_longitude": "15.0",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              params=params,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers?api_method=count_in_range&latitude=51.5074&longitude=-0.1278&radius=50&sw_latitude=48.0&sw_longitude=8.0&ne_latitude=54.0&ne_longitude=15.0", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers?api_method=count_in_range&latitude=51.5074&longitude=-0.1278&radius=50&sw_latitude=48.0&sw_longitude=8.0&ne_latitude=54.0&ne_longitude=15.0");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers?api_method=count_in_range&latitude=51.5074&longitude=-0.1278&radius=50&sw_latitude=48.0&sw_longitude=8.0&ne_latitude=54.0&ne_longitude=15.0")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/clickworker_details:
    get:
      tags:
      - Clickworkers
      summary: Clickworkers.details
      description: |-
        ## Clickworkers.details

        Returns demographic details for a single clickworker. Similar to `Clickworkers.demographics` but uses a different route and query parameter pattern.

        **Response fields:** `clickworker_id`, `gender`, `city`, `postal_code`, `state`, `country`
      operationId: clickworkersdetails
      parameters:
      - name: id
        in: query
        required: false
        description: Numeric clickworker user ID
        schema:
          type: string
          example: '{{clickworkerId}}'
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/clickworker_details?id={{clickworkerId}}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/clickworker_details"
          params = {
              "id": "{{clickworkerId}}",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              params=params,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/clickworker_details?id={{clickworkerId}}", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/clickworker_details?id={{clickworkerId}}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/clickworker_details?id={{clickworkerId}}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/clickworkers/demographics/{clickworkerId}:
    get:
      tags:
      - Clickworkers
      summary: Clickworkers.demographics (single)
      description: |-
        ## Clickworkers.demographics (single)

        Returns demographic data for a single clickworker.

        **Response fields:** `gender`, `city`, `postal_code`, `state`, `country`
      operationId: clickworkersdemographicsSingle
      parameters:
      - name: clickworkerId
        in: path
        required: true
        description: Numeric clickworker user ID
        schema:
          type: string
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers/demographics/{clickworkerId}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers/demographics/{clickworkerId}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers/demographics/{clickworkerId}", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers/demographics/{clickworkerId}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers/demographics/{clickworkerId}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/clickworkers/demographics:
    get:
      tags:
      - Clickworkers
      summary: Clickworkers.demographics (batch)
      description: |-
        ## Clickworkers.demographics (batch)

        Returns demographic data for up to **100 clickworkers** in a single request.

        Provide IDs as a comma-separated string in `user_ids` or as an array. Returns `gender`, `city`, `postal_code`, `state`, and `country` for each worker.
      operationId: clickworkersdemographicsBatch
      parameters:
      - name: user_ids
        in: query
        required: false
        description: Comma-separated clickworker IDs (max 100)
        schema:
          type: string
          example: 12345,67890,11111
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers/demographics?user_ids=12345,67890,11111' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers/demographics"
          params = {
              "user_ids": "12345,67890,11111",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              params=params,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers/demographics?user_ids=12345,67890,11111", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers/demographics?user_ids=12345,67890,11111");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/clickworkers/demographics?user_ids=12345,67890,11111")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/orders:
    get:
      tags:
      - Orders
      - Product Survey
      summary: Orders.index
      description: |-
        ## Orders.index

        Lists all orders for the customer account.
      operationId: ordersindex
      parameters:
      - name: _page_size
        in: query
        required: false
        schema:
          type: string
          example: '50'
      - name: _page_number
        in: query
        required: false
        schema:
          type: string
          example: '1'
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders?_page_size=50&_page_number=1' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders"
          params = {
              "_page_size": "50",
              "_page_number": "1",
          }
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              params=params,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders?_page_size=50&_page_number=1", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders?_page_size=50&_page_number=1");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders?_page_size=50&_page_number=1")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/orders/{orderId}:
    get:
      tags:
      - Orders
      - Product Survey
      summary: Order.show
      description: |-
        ## Order.show

        Returns full details for a specific order including task counts, status breakdown, and financial summary.
      operationId: ordershow
      parameters:
      - name: orderId
        in: path
        required: true
        description: Numeric order ID
        schema:
          type: string
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
    patch:
      tags:
      - Orders
      - Product Survey
      summary: Order.update / Order.update
      description: |-
        ### Order.update

        ## Order.update

        Updates order metadata.

        **Body fields:**

        | Field | Description |
        |---|---|
        | `customer_reference` | Your internal reference string for this order |
        | `promotional_image_id` | ID of a promotional image to attach; set to `null` to remove |
      operationId: orderupdate
      parameters:
      - name: orderId
        in: path
        required: true
        description: Numeric order ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              Order_update:
                summary: Order.update
                value:
                  order:
                    customer_reference: my-internal-ref-001
                    promotional_image_id: null
              Order_update_2:
                summary: Order.update
                value:
                  order:
                    customer_reference: custom reference
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X PATCH \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '
          {
            "order": {
              "customer_reference": "my-internal-ref-001",
              "promotional_image_id": null
            }
          }
          '
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "order": {
              "customer_reference": "my-internal-ref-001",
              "promotional_image_id": null
            }
          }

          response = requests.patch(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}", {
            method: "PATCH",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "order": {
              "customer_reference": "my-internal-ref-001",
              "promotional_image_id": null
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"order": {"customer_reference": "my-internal-ref-001", "promotional_image_id": null}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Patch.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "order": {
              "customer_reference": "my-internal-ref-001",
              "promotional_image_id": null
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/orders/{orderId}/complete:
    put:
      tags:
      - Orders
      - Product Survey
      summary: Order.complete / Orders.complete
      description: |-
        ### Order.complete

        ## Order.complete

        Manually completes an order that has no active tasks remaining. Use when you want to formally close an order that is in a pending-complete state.
      operationId: ordercomplete
      parameters:
      - name: orderId
        in: path
        required: true
        description: Numeric order ID
        schema:
          type: string
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X PUT \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/complete' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/complete"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.put(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/complete", {
            method: "PUT",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/complete");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/complete")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Put.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/orders/{orderId}/terminate:
    post:
      tags:
      - Orders
      summary: Order.terminate
      description: |-
        ## Order.terminate

        Ends an order early. Tasks that have not been worked on are cancelled; tasks that already carry completed work are kept and billed. The order is then resolved asynchronously into `completed` (if any work survived) or `cancelled` (if none did).

        Returns `202 Accepted` immediately -- the order's own state is unchanged in the response (it stays `accepted`). The terminal state is determined asynchronously; poll `GET /api/marketplace/v2/customer/orders/{{orderId}}` to discover the outcome, or subscribe to the `core.model.change.order` notification.

        Orders with no tasks yet (`new`, `confirmed`, `verifying`, `reviewing`) are cancelled synchronously instead, and this endpoint returns `200`.

        An optional `termination_reason` string is recorded against the order.
      operationId: orderterminate
      parameters:
      - name: orderId
        in: path
        required: true
        description: Numeric order ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                termination_reason:
                  type: string
            example:
              termination_reason: No longer needed
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X POST \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/terminate' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"termination_reason": "No longer needed"}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/terminate"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "termination_reason": "No longer needed"
          }

          response = requests.post(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/terminate", {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "termination_reason": "No longer needed"
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/terminate");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"termination_reason": "No longer needed"}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/terminate")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Post.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "termination_reason": "No longer needed"
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/orders/{orderId}/blocklist:
    get:
      tags:
      - Allow/Block List Copy
      summary: Blocklist.show
      description: Show all running Tasks.
      operationId: blocklistshow
      parameters:
      - name: orderId
        in: path
        required: true
        description: Numeric order ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                blocklist:
                  type: object
                  properties:
                    add_user_ids:
                      type: array
                      items:
                        type: integer
                    remove_user_ids:
                      type: array
                      items:
                        type: integer
            example:
              blocklist:
                add_user_ids:
                - 2
                - 6
                - 9
                remove_user_ids:
                - 9
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/blocklist' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/blocklist"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/blocklist", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/blocklist");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/blocklist")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
    put:
      tags:
      - Allow/Block List Copy
      summary: Blocklist.update
      description: Show all running Tasks.
      operationId: blocklistupdate
      parameters:
      - name: orderId
        in: path
        required: true
        description: Numeric order ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                blocklist:
                  type: object
                  properties:
                    add_user_ids:
                      type: array
                      items:
                        type: integer
                    remove_user_ids:
                      type: array
                      items:
                        type: integer
            example:
              blocklist:
                add_user_ids:
                - 2
                - 6
                - 9
                remove_user_ids:
                - 9
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X PUT \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/blocklist' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"blocklist": {"add_user_ids": [2, 6, 9], "remove_user_ids": [9]}}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/blocklist"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "blocklist": {
              "add_user_ids": [
                2,
                6,
                9
              ],
              "remove_user_ids": [
                9
              ]
            }
          }

          response = requests.put(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/blocklist", {
            method: "PUT",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "blocklist": {
              "add_user_ids": [
                2,
                6,
                9
              ],
              "remove_user_ids": [
                9
              ]
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/blocklist");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"blocklist": {"add_user_ids": [2, 6, 9], "remove_user_ids": [9]}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/blocklist")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Put.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "blocklist": {
              "add_user_ids": [
                2,
                6,
                9
              ],
              "remove_user_ids": [
                9
              ]
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/orders/{orderId}/allowlist:
    get:
      tags:
      - Allow/Block List Copy
      summary: Allowlist.show
      description: Show all running Tasks.
      operationId: allowlistshow
      parameters:
      - name: orderId
        in: path
        required: true
        description: Numeric order ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                blocklist:
                  type: object
                  properties:
                    add_user_ids:
                      type: array
                      items:
                        type: integer
                    remove_user_ids:
                      type: array
                      items:
                        type: integer
            example:
              blocklist:
                add_user_ids:
                - 2
                - 6
                - 9
                remove_user_ids:
                - 9
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/allowlist' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/allowlist"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/allowlist", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/allowlist");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/allowlist")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
    put:
      tags:
      - Allow/Block List Copy
      summary: Allowlist.update
      description: Show all running Tasks.
      operationId: allowlistupdate
      parameters:
      - name: orderId
        in: path
        required: true
        description: Numeric order ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                blocklist:
                  type: object
                  properties:
                    add_user_ids:
                      type: array
                      items:
                        type: integer
                    remove_user_ids:
                      type: array
                      items:
                        type: integer
            example:
              blocklist:
                add_user_ids:
                - 2
                - 6
                - 9
                remove_user_ids:
                - 9
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X PUT \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/allowlist' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '{"blocklist": {"add_user_ids": [2, 6, 9], "remove_user_ids": [9]}}'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/allowlist"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "blocklist": {
              "add_user_ids": [
                2,
                6,
                9
              ],
              "remove_user_ids": [
                9
              ]
            }
          }

          response = requests.put(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/allowlist", {
            method: "PUT",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "blocklist": {
              "add_user_ids": [
                2,
                6,
                9
              ],
              "remove_user_ids": [
                9
              ]
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/allowlist");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"blocklist": {"add_user_ids": [2, 6, 9], "remove_user_ids": [9]}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/orders/{orderId}/allowlist")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Put.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "blocklist": {
              "add_user_ids": [
                2,
                6,
                9
              ],
              "remove_user_ids": [
                9
              ]
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/customer/notify_workers:
    post:
      tags:
      - Customer Account Management
      summary: Customer.notify_workers
      description: |-
        ## Customer.notify_workers

        Sends a push notification to specific clickworkers. Useful for alerting your team panel when new tasks are available.

        **Body fields:**

        | Field | Description |
        |---|---|
        | `subject` | Notification subject line |
        | `message` | Notification body text |
        | `clickworker_ids` | Array of clickworker user IDs to notify |
      operationId: customernotify_workers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                notify_workers:
                  type: object
                  properties:
                    subject:
                      type: string
                    message:
                      type: string
                    clickworker_ids:
                      type: array
                      items:
                        type: integer
            example:
              notify_workers:
                subject: New task available
                message: We have a new batch of tasks ready for you.
                clickworker_ids:
                - 12345
                - 67890
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X POST \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/customer/notify_workers' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json' \
            -d '
          {
            "notify_workers": {
              "subject": "New task available",
              "message": "We have a new batch of tasks ready for you.",
              "clickworker_ids": [
                12345,
                67890
              ]
            }
          }
          '
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/notify_workers"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")
          payload = {
            "notify_workers": {
              "subject": "New task available",
              "message": "We have a new batch of tasks ready for you.",
              "clickworker_ids": [
                12345,
                67890
              ]
            }
          }

          response = requests.post(
              url,
              headers=headers,
              auth=auth,
              json=payload
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/notify_workers", {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
            body: JSON.stringify({
            "notify_workers": {
              "subject": "New task available",
              "message": "We have a new batch of tasks ready for you.",
              "clickworker_ids": [
                12345,
                67890
              ]
            }
          }),
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/customer/notify_workers");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);
          curl_setopt($ch, CURLOPT_POSTFIELDS, '{"notify_workers": {"subject": "New task available", "message": "We have a new batch of tasks ready for you.", "clickworker_ids": [12345, 67890]}}');

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/customer/notify_workers")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Post.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')
          request.body = {
            "notify_workers": {
              "subject": "New task available",
              "message": "We have a new batch of tasks ready for you.",
              "clickworker_ids": [
                12345,
                67890
              ]
            }
          }.to_json

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '201':
          description: Resource created
        '422':
          description: Validation error
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/products/Survey:
    get:
      tags:
      - Product Survey
      summary: 03.3 Product.show (Survey)
      description: Show Product Details for ExternalForm (Survey) product.
      operationId: 033ProductshowSurvey
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/products/Survey' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/products/Survey"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/products/Survey", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/products/Survey");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/products/Survey")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/clickworker/demographics/{clickworkerId}:
    get:
      tags:
      - Product Survey
      summary: Clickworker.demographics
      description: Show status of the submitted task.
      operationId: clickworkerdemographics
      parameters:
      - name: clickworkerId
        in: path
        required: true
        schema:
          type: string
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/clickworker/demographics/{clickworkerId}' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/clickworker/demographics/{clickworkerId}"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/clickworker/demographics/{clickworkerId}", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/clickworker/demographics/{clickworkerId}");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/clickworker/demographics/{clickworkerId}")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/products/Sentiment:
    get:
      tags:
      - Product Sentiment
      summary: 03.3 Product.show (Sentiment)
      description: Show Product Details for ExternalForm (Sentiment) product.
      operationId: 033ProductshowSentiment
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/products/Sentiment' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/products/Sentiment"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/products/Sentiment", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/products/Sentiment");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/products/Sentiment")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
  /api/marketplace/v2/products/ExternalForm:
    get:
      tags:
      - Product iFrame
      summary: 03.1 Product.show (iFrame)
      description: Show Product Details for ExternalForm (iFrame) product. Inspect Product.show to determine the list of configuration
        paratemers available for the product.
      operationId: 031ProductshowIframe
      x-codeSamples:
      - lang: curl
        label: cURL
        source: |-
          curl -X GET \
            'https://api-sandbox.clickworker.com/api/marketplace/v2/products/ExternalForm' \
            -u 'YOUR_EMAIL:YOUR_PASSWORD' \
            -H 'Content-Type: application/json' \
            -H 'Accept: application/json'
      - lang: Python
        source: |-
          import requests

          url = "https://api-sandbox.clickworker.com/api/marketplace/v2/products/ExternalForm"
          headers = {
              "Content-Type": "application/json",
              "Accept": "application/json",
          }
          auth = ("YOUR_EMAIL", "YOUR_PASSWORD")

          response = requests.get(
              url,
              headers=headers,
              auth=auth
          )
          print(response.status_code)
          print(response.json())
      - lang: JavaScript
        source: |-
          const credentials = btoa('YOUR_EMAIL:YOUR_PASSWORD');

          const response = await fetch("https://api-sandbox.clickworker.com/api/marketplace/v2/products/ExternalForm", {
            method: "GET",
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "Authorization": `Basic ${credentials}`,
            },
          });

          const data = await response.json();
          console.log(data);
      - lang: PHP
        source: |-
          <?php

          $ch = curl_init();

          curl_setopt($ch, CURLOPT_URL, "https://api-sandbox.clickworker.com/api/marketplace/v2/products/ExternalForm");
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          curl_setopt($ch, CURLOPT_USERPWD, "YOUR_EMAIL:YOUR_PASSWORD");
          curl_setopt($ch, CURLOPT_HTTPHEADER, [
              "Content-Type: application/json",
              "Accept: application/json",
          ]);

          $response = curl_exec($ch);
          $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
          curl_close($ch);

          echo "Status: $httpCode\n";
          echo $response;
      - lang: Ruby
        source: |-
          require 'net/http'
          require 'json'
          require 'uri'

          uri = URI("https://api-sandbox.clickworker.com/api/marketplace/v2/products/ExternalForm")
          http = Net::HTTP.new(uri.host, uri.port)
          http.use_ssl = true

          request = Net::HTTP::Get.new(uri)
          request['Content-Type'] = 'application/json'
          request['Accept'] = 'application/json'
          request.basic_auth('YOUR_EMAIL', 'YOUR_PASSWORD')

          response = http.request(request)
          puts "Status: #{response.code}"
          puts JSON.parse(response.body)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_status:
                    type: object
                    properties:
                      status_code:
                        type: integer
                      valid:
                        type: boolean
                      messages:
                        type: array
                        items:
                          type: string
        '401':
          description: Authentication required
        '404':
          description: Resource not found
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Auth with your customer email and password
    accessToken:
      type: apiKey
      in: query
      name: access_token
      description: Token-based authentication for Asset Library endpoints