Deel

Deel Payslips API

Employee payslips

Documentation GitHub OpenAPI

Business capability

HR Operations Management BC-300.70

Operations 2

GET /gp/workers/{id}/payslips Retrieve employee payslips #

GET /payslips List Payslips #

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/deel-com:deel-com-payslips-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Deel Com Payslips API
  version: '1.0'
  description: 'Operations tagged payslips across 2 of this provider''s published API definitions: deel-com-openapi.yml, deel-global-payroll-api-openapi.yml. Each path carries the servers of the definition it was published in.'
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
- url: https://api.letsdeel.com/rest/v2
  description: Production
- url: https://api-sandbox.demo.deel.com/rest/v2
  description: Sandbox
tags:
- name: payslips
paths:
  /gp/workers/{id}/payslips:
    get:
      operationId: payslips_getGPWorkerPayslips
      summary: Retrieve employee payslips
      description: 'Returns the payslip history for a GP employee, including each payslip''s date range and status. Restricted to GP contract types. Each payslip in the response includes an `id` required by the payslip download endpoint.


        **Token scopes**: `payslips:read`, `worker:read`'
      tags:
      - payslips
      parameters:
      - name: id
        in: path
        description: Unique identifier for the worker.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payslips_getGPWorkerPayslips_Response_200'
        '400':
          description: Bad Request - Validation error or invalid parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveEmployeePayslips-v2026-01-01RequestBadRequestError'
        '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: []
    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
  /payslips:
    get:
      operationId: getPayslips
      summary: List Payslips
      tags:
      - payslips
      parameters:
      - name: worker_id
        in: query
        schema:
          type: string
      - name: year
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: Payslips
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Payslip'
      security:
      - BearerAuth: []
    servers:
    - url: https://api.letsdeel.com/rest/v2
      description: Production
    - url: https://api-sandbox.demo.deel.com/rest/v2
      description: Sandbox
components:
  schemas:
    payslips_getGPWorkerPayslips_Response_200:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems'
      required:
      - data
      title: payslips_getGPWorkerPayslips_Response_200
    GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaErrorsItems:
      type: object
      properties:
        message:
          type: string
          description: Error response
      required:
      - message
      title: GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaErrorsItems
    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
    ApiErrorContainer:
      type: object
      properties:
        request:
          $ref: '#/components/schemas/ApiErrorRequest'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ApiError'
      title: ApiErrorContainer
    RetrieveEmployeePayslips-v2026-01-01RequestBadRequestError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaErrorsItems'
          description: Error messages
        request:
          $ref: '#/components/schemas/GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaRequest'
          description: Error request details
      required:
      - errors
      title: RetrieveEmployeePayslips-v2026-01-01RequestBadRequestError
    GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaRequest:
      type: object
      properties:
        method:
          type: string
          description: Method of the API
        status:
          type: number
          format: double
          description: Status of API response
      description: Error request details
      title: GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaRequest
    GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the payslip.
        to:
          type: string
          format: date
          description: End date of the payslip period in ISO-8601 format.
        from:
          type: string
          format: date
          description: Start date of the payslip period in ISO-8601 format.
        status:
          type: string
          description: The current status of the payslip (e.g., AVAILABLE, PENDING, PUBLISHED).
      required:
      - id
      - to
      - from
      - status
      title: GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems
    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
    Payslip:
      type: object
      properties:
        id:
          type: string
        worker_id:
          type: string
        period_start:
          type: string
          format: date
        period_end:
          type: string
          format: date
        gross:
          type: number
        net:
          type: number
        currency:
          type: string
        download_url:
          type: string
          format: uri
  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/
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
x-refined-from:
- deel-com-openapi.yml
- deel-global-payroll-api-openapi.yml

Deel Payslips API

Operations 2

Documentation

Specifications

Schemas & Data

Other Resources