Deel Worker Session API

openapi: 3.2.0
info:
  title: Endpoints Worker Session API
  version: 1.0.0
  description: API endpoints related to Worker Session.
servers:
- url: https://api.letsdeel.com/rest
  description: Production
- url: https://api-staging.letsdeel.com/rest
  description: Demo
- url: https://api.letsdeel.com/scim/v2
  description: Production
- url: https://api-staging.letsdeel.com/scim/v2
  description: Demo
tags:
- name: workerSession
  description: API endpoints related to Worker Session.
paths:
  /workers/session:
    post:
      operationId: workerSession_createWorkerAccessToken-v2026-01-01
      summary: Create worker access token
      description: 'Issues a scoped access token granting a worker access to worker-side API endpoints. The response includes the token value and its expiry timestamp.


        **Token scopes**: `admin:worker`'
      tags:
      - workerSession
      responses:
        '201':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Worker_Session_createWorkerAccessToken-v2026-01-01_Response_201'
        '400':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '401':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '403':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '404':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '500':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/WorkersSessionPostRequestBodyContentApplicationJsonSchemaData'
              required:
              - data
      security:
      - deelToken: []
  /workers/{worker_id}/session:
    delete:
      operationId: workerSession_deleteWorkerAccessToken-v2026-01-01
      summary: Delete worker access token
      description: 'Immediately revokes the active access token for the worker identified by worker_id, terminating all API access granted by that token.


        **Token scopes**: `admin:worker`'
      tags:
      - workerSession
      parameters:
      - name: worker_id
        in: path
        description: The ID of the worker whose access token you want to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successful operation.
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '401':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '403':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '404':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '500':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
      security:
      - deelToken: []
components:
  schemas:
    ApiErrorRequest:
      type: object
      properties:
        method:
          type: string
          description: The HTTP method of the failed request
        url:
          type: string
          description: The relative URL of the failed request
        status:
          type: number
          format: double
          description: The status code of the response
        api_req_id:
          type: string
          description: The request ID of the failed request
        docs:
          type: string
          description: A link to the official documentation for the requested endpoint resource
        source:
          type: string
          description: The source handler which produced the returned error
        code:
          type: number
          format: double
          description: The code of the source handler which produced the returned error
      title: ApiErrorRequest
    ApiError:
      type: object
      properties:
        message:
          type: string
          description: A description of the returned error
        path:
          type: string
          description: The JSON path where input validation failed
      title: ApiError
    Worker_Session_createWorkerAccessToken-v2026-01-01_Response_201:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/WorkersSessionPostResponsesContentApplicationJsonSchemaData'
      required:
      - data
      title: Worker Session_createWorkerAccessToken-v2026-01-01_Response_201
    ApiErrorContainer:
      type: object
      properties:
        request:
          $ref: '#/components/schemas/ApiErrorRequest'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ApiError'
      title: ApiErrorContainer
    WorkersSessionPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        token:
          type: string
          description: Access token
        expires_at:
          type: string
          format: date-time
          description: Expiration date of the access token
      required:
      - token
      - expires_at
      title: WorkersSessionPostResponsesContentApplicationJsonSchemaData
    WorkersSessionPostRequestBodyContentApplicationJsonSchemaData:
      type: object
      properties:
        profile_id:
          type: string
          format: uuid
          description: The ID of the profile to create access token for
      required:
      - profile_id
      title: WorkersSessionPostRequestBodyContentApplicationJsonSchemaData
  securitySchemes:
    deelToken:
      type: http
      scheme: bearer
      description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)"
    oauth2:
      type: http
      scheme: bearer
      description: Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/
x-provenance:
  method: harvested
  publisher: Deel
  source: https://developer.deel.com/openapi/endpoints-5.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)