Buk

Buk Substitutions API

The Substitutions API from Buk — 2 operation(s) for substitutions.

Operations 4

GET /substitutions Get substitutions #
POST /substitutions Create substitutions #
PATCH /substitutions/{id} Update substitutions by id #
DELETE /substitutions/{id} Delete substitutions by 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/buk-substitutions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

buk-substitutions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: '# Buk Data Access API.


    To use the API, you need to obtain an **API Key**.

    You can manage access within the platform, in **Settings => API Access.**


    Once an API Key is created, you must send the value as a header in the HTTP request, in the `auth_token` field.


    ## For more details, you can review the article "How to integrate with Buk through an API"


    # Endpoints'
  title: Buk Substitutions API
servers:
- url: https://demo.buk.cl/api/v1/brasil
tags:
- name: Substitutions
paths:
  /substitutions:
    get:
      tags:
      - Substitutions
      description: 'Obtain substitutions


        Attributes description:

        - `id`: Unique identifier of the substitution.

        - `active`: Status of the substitution.

        - `employee_id`: Id of the Colaboradores.

        - `substitute_id`: Id of the substitute Colaboradores.

        - `start_date`: Start date of the substitution.

        - `end_date`: End date of the substitution.

        - `reason`: Cause of the substitution.


        **Permisos requeridos para utilizar este endpoint:**

        * Employee permissions en: ''Lectura''.'
      parameters:
      - name: page
        in: query
        description: 'Optional query parameters to filter and label substitutions.

          '
        schema:
          type: integer
      - name: page_size
        in: query
        description: 'Optional query parameters to filter and label substitutions.

          '
        schema:
          type: integer
      responses:
        '200':
          description: 'API response when retrieving substitutions with labels and details of each substitution.

            '
          name: data
          content:
            application/json:
              schema:
                properties:
                  pagination:
                    $ref: '#/components/schemas/Pagination'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/EmployeeSubstitutionDetail'
            application/pdf:
              schema:
                properties:
                  pagination:
                    $ref: '#/components/schemas/Pagination'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/EmployeeSubstitutionDetail'
      summary: Get substitutions
      x-summary-source: derived
      operationId: getSubstitutions
      x-operation-id-source: derived
    post:
      tags:
      - Substitutions
      description: 'Create a new substitution


        Attribute description:

        - `active`: Status of the substitution.

        - `employee_id`: Id of the Colaboradores.

        - `substitute_id`: Id of the substitute Colaboradores.

        - `start_date`: Start date of the substitution.

        - `end_date`: End date of the substitution.

        - `reason`: Reason for the substitution.


        **Permisos requeridos para utilizar este endpoint:**

        * Employee permissions en: ''Lectura y Modificación''.'
      responses:
        '201':
          description: 'API response upon creating a new substitution, including details of the created substitution.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeSubstitutionDetail'
            application/pdf:
              schema:
                $ref: '#/components/schemas/EmployeeSubstitutionDetail'
        '400':
          description: 'Invalid entry

            '
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeeSubstitutionInput'
        description: 'Data for the new substitution to be created, including ID’s of the Colaborador and the substitute, start and end dates, and status.

          '
        required: true
      summary: Create substitutions
      x-summary-source: derived
      operationId: postSubstitutions
      x-operation-id-source: derived
  /substitutions/{id}:
    patch:
      tags:
      - Substitutions
      description: 'Updates a specific substitution

        Attribute description:

        - `active`: Status of the substitution.

        - `employee_id`: Id of the Colaboradores.

        - `substitute_id`: Id of the substitute Colaboradores.

        - `start_date`: Start date of the substitution.

        - `end_date`: End date of the substitution.

        - `reason`: Reason for the substitution.


        **Permisos requeridos para utilizar este endpoint:**

        * Employee permissions en: ''Lectura y Modificación''.'
      parameters:
      - name: id
        in: path
        description: 'Substitution ID to be updated

          '
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: 'API response after successful update of a substitution

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeSubstitutionDetail'
            application/pdf:
              schema:
                $ref: '#/components/schemas/EmployeeSubstitutionDetail'
        '400':
          description: 'Invalid entry

            '
        '404':
          description: 'Substitution not found

            '
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeeSubstitutionInput'
        description: 'Data to be updated in the existing substitution, such as start and end dates or status

          '
        required: true
      summary: Update substitutions by id
      x-summary-source: derived
      operationId: patchSubstitutionsById
      x-operation-id-source: derived
    delete:
      tags:
      - Substitutions
      description: 'Eliminate a specific substitution


        **Permisos requeridos para utilizar este endpoint:**

        * Employee permissions en: ''Lectura y Modificación''.'
      parameters:
      - name: id
        in: path
        description: 'Substitution ID to be deleted

          '
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: 'API response after successful deletion of a substitution

            '
        '404':
          description: 'Substitution not found

            '
        '422':
          description: 'It was not possible to eliminate the substitution

            '
      summary: Delete substitutions by id
      x-summary-source: derived
      operationId: deleteSubstitutionsById
      x-operation-id-source: derived
components:
  schemas:
    Pagination:
      properties:
        next:
          type: string
        previous:
          type: string
        count:
          type: integer
        total_pages:
          type: integer
    EmployeeSubstitutionDetail:
      properties:
        id:
          type: integer
          readOnly: true
        active:
          type: boolean
        employee_id:
          type: integer
        substitute_id:
          type: integer
        start_date:
          type: string
          format: date
        end_date:
          type: string
          format: date
        reason:
          type: string
          description: Causal
    EmployeeSubstitutionInput:
      properties:
        active:
          type: boolean
        employee_id:
          type: integer
        substitute_id:
          type: integer
        start_date:
          type: string
          format: date
        end_date:
          type: string
          format: date
        reason:
          type: string
          description: Causal
  securitySchemes:
    auth_token:
      type: apiKey
      name: auth_token
      in: header