dados.gov.pt Workers API

Asynchronous workers related operations

GitHub OpenAPI

Operations 7

GET /workers/jobs/ List all scheduled jobs #
POST /workers/jobs/ Create a new scheduled job #
GET /workers/jobs/schedulables/ List all schedulable jobs #
DELETE /workers/jobs/{id}/ Delete a single scheduled job #
GET /workers/jobs/{id}/ Fetch a single scheduled job #
PUT /workers/jobs/{id}/ Update a single scheduled job #
GET /workers/tasks/{id}/ Get a tasks status given its ID #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/open-government-portugal:open-government-portugal-workers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

open-government-portugal-workers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: uData API
  title: uData Workers API
  version: '1.0'
servers:
- url: /api/1
tags:
- description: Asynchronous workers related operations
  name: Workers
paths:
  /workers/jobs/:
    get:
      operationId: list_jobs
      parameters:
      - description: An optional fields mask
        in: header
        name: X-Fields
        schema:
          type: string
          format: mask
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Job'
                type: array
      summary: List all scheduled jobs
      tags:
      - Workers
    post:
      operationId: post_jobs_api
      parameters:
      - description: An optional fields mask
        in: header
        name: X-Fields
        schema:
          type: string
          format: mask
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
      summary: Create a new scheduled job
      tags:
      - Workers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Job'
        required: true
  /workers/jobs/schedulables/:
    get:
      operationId: get_jobs_reference_api
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      summary: List all schedulable jobs
      tags:
      - Workers
  /workers/jobs/{id}/:
    parameters:
    - description: A job ID
      in: path
      name: id
      required: true
      schema:
        type: string
    delete:
      operationId: delete_job_api
      responses:
        '204':
          description: Successfuly deleted
      summary: Delete a single scheduled job
      tags:
      - Workers
    get:
      operationId: get_job_api
      parameters:
      - description: An optional fields mask
        in: header
        name: X-Fields
        schema:
          type: string
          format: mask
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
      summary: Fetch a single scheduled job
      tags:
      - Workers
    put:
      operationId: put_job_api
      parameters:
      - description: An optional fields mask
        in: header
        name: X-Fields
        schema:
          type: string
          format: mask
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
      summary: Update a single scheduled job
      tags:
      - Workers
  /workers/tasks/{id}/:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    get:
      operationId: get_task_api
      parameters:
      - description: An optional fields mask
        in: header
        name: X-Fields
        schema:
          type: string
          format: mask
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
      summary: Get a tasks status given its ID
      tags:
      - Workers
components:
  schemas:
    Interval:
      properties:
        every:
          description: The interval without unit
          type: integer
        period:
          description: The period/interval type
          enum:
          - days
          - hours
          - minutes
          - seconds
          - microseconds
          example: days
          type: string
      required:
      - every
      - period
      type: object
    Crontab:
      properties:
        day_of_month:
          default: '*'
          description: Cron expression for day of month
          type: string
        day_of_week:
          default: '*'
          description: Cron expression for day of week
          type: string
        hour:
          default: '*'
          description: Cron expression for hour
          type: string
        minute:
          default: '*'
          description: Cron expression for minute
          type: string
        month_of_year:
          default: '*'
          description: Cron expression for month of year
          type: string
      required:
      - day_of_month
      - day_of_week
      - hour
      - minute
      - month_of_year
      type: object
    Job:
      properties:
        args:
          default: []
          description: The job execution arguments
          items:
            type: object
          type: array
        crontab:
          $ref: '#/components/schemas/Crontab'
        description:
          description: The job description
          type: string
        enabled:
          default: false
          description: Is this job enabled
          type: boolean
        id:
          description: The job unique identifier
          readOnly: true
          type: string
        interval:
          $ref: '#/components/schemas/Interval'
        kwargs:
          default: {}
          description: The job execution keyword arguments
          type: object
        last_run_at:
          description: The last job execution date
          format: date-time
          readOnly: true
          type: string
        last_run_id:
          description: The last execution task id
          readOnly: true
          type: string
        name:
          description: The job unique name
          type: string
        schedule:
          description: The schedule display
          readOnly: true
          type: string
        task:
          description: The task name
          enum:
          - test-high-queue
          - test-default-queue
          - test-error
          - purge-chunks
          - aggregate-metrics
          - update-badges
          - check-integrity
          - bind-tabular-dataservice
          - delete-expired-notifications
          - test-log
          - purge-harvesters
          - purge-datasets
          - purge-reuses
          - test-low-queue
          - count-tags
          - purge-harvest-jobs
          - purge-dataservices
          - recommendations-clean
          - compute-site-metrics
          - map-transport-datasets
          - recommendations-add
          - notify-inactive-users
          - harvest
          - update-metrics
          - compute-geozones-metrics
          - purge-organizations
          - purge-topics-elements
          - export-csv
          - delete-inactive-users
          example: test-high-queue
          type: string
      required:
      - name
      - task
      type: object
    Task:
      properties:
        exc:
          description: The exception thrown during execution
          type: string
        id:
          description: Tha task execution ID
          readOnly: true
          type: string
        result:
          description: The task results if exists
          type: string
        status:
          description: Cron expression for hour
          enum:
          - STARTED
          - FAILURE
          - RETRY
          - REVOKED
          - PENDING
          - SUCCESS
          - RECEIVED
          example: STARTED
          readOnly: true
          type: string
        traceback:
          description: The execution traceback
          type: string
      type: object
  securitySchemes:
    apikey:
      in: header
      name: X-API-KEY
      type: apiKey