Sense Talent Labs

Sense Talent Labs Appointment API

An interview or a meeting with a Candidate or Contact.

GitHub OpenAPI
Business capability
Talent Acquisition Management BC-300.10

Operations 5

POST /appointments Upsert Appointment #
GET /appointments/{id} Retrieve Appointment details #
PATCH /appointments/{id} Update Appointment #
GET /appointments/possible-values/{fieldName} Get possible values for a Appointment field #
PUT /appointments/possible-values/{fieldName} Update possible values for a Appointment field #

Documentation

📖
Documentation
https://developer.sensehq.com/
📖
APIReference
https://developer.sensehq.com/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sense-talent-labs/refs/heads/main/authentication/sense-talent-labs-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/sense-talent-labs/refs/heads/main/rate-limits/sense-talent-labs-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sense-talent-labs/refs/heads/main/openapi/sense-talent-labs-appointment-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sense-talent-labs/refs/heads/main/errors/sense-talent-labs-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sense-talent-labs/refs/heads/main/data-model/sense-talent-labs-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/sense-talent-labs/refs/heads/main/asyncapi/sense-talent-labs-writeback-webhooks.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/sense-talent-labs/refs/heads/main/apis.yml

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/sense-talent-labs-appointment-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.

GitHub Google LinkedIn

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

OpenAPI Specification

sense-talent-labs-appointment-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: '# Overview

    ### Introduction

    Use the Sense API to synchronize your ATS data into the Sense Platform.'
  title: Sense Appointment API
  version: ''
servers:
- url: https://partner-api.us-stage.sensehq.co
security:
- sense_bearer_auth: []
tags:
- description: An interview or a meeting with a Candidate or Contact.
  name: Appointment
paths:
  /appointments:
    post:
      description: Batch upsert Appointment entities.
      operationId: post_appointments
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/Appointment'
              maxItems: 500
              minItems: 1
              type: array
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/201_response_schema'
          description: Request accepted for async processing.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_response_schema'
          description: Invalid request. Message will indicate which field failed validation.
        '413':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_response_schema'
          description: Payload too large
      summary: Upsert Appointment
      tags:
      - Appointment
  /appointments/{id}:
    get:
      description: Fetch details of a single Appointment entity by its unique ID.
      operationId: get_appointments
      parameters:
      - description: The unique ID of the Appointment whose details need to be retrieved.
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_response_schema'
          description: Successful response containing Appointment details.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_response_schema'
          description: Invalid request. Message will indicate which field failed validation.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_response_schema'
          description: Appointment not found.
      summary: Retrieve Appointment details
      tags:
      - Appointment
    patch:
      description: Update single Appointment entity.
      operationId: patch_appointments
      parameters:
      - description: The unique id of the Appointmentwhose details need to be updated.
        in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Appointment'
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/201_response_schema'
          description: Request accepted for async processing.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_response_schema'
          description: Invalid request. Message will indicate which field failed validation.
        '413':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_response_schema'
          description: Payload too large
      summary: Update Appointment
      tags:
      - Appointment
  /appointments/possible-values/{fieldName}:
    get:
      description: Fetch the list of possible values configured for a field on the Appointment entity. These values define dropdown options used in various Sense workflows.
      operationId: get_appointments_possible_values
      parameters:
      - description: The field name for which possible values should be retrieved.
        in: path
        name: fieldName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PossibleValuesGetResponse'
          description: Successful response containing possible values.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_response_schema'
          description: Invalid request.
      summary: Get possible values for a Appointment field
      tags:
      - Appointment
    put:
      description: A self-serve endpoint to synchronize dropdown options with your ATS configuration, ensuring data integrity during field writebacks.
      operationId: put_appointments_possible_values
      parameters:
      - description: The field name whose possible values should be updated.
        in: path
        name: fieldName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
            - label: Hourly
              value: hourly
            - label: Daily
              value: daily
            schema:
              items:
                properties:
                  label:
                    type: string
                  value:
                    oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                required:
                - label
                - value
                type: object
              type: array
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PossibleValuesPutResponse'
          description: Updated possible values returned in the response.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400_response_schema'
          description: Invalid request payload.
      summary: Update possible values for a Appointment field
      tags:
      - Appointment
components:
  schemas:
    PossibleValuesPutResponse:
      properties:
        data:
          properties:
            field_name:
              type: string
            object_name:
              type: string
            possibleValues:
              items:
                properties:
                  label:
                    type: string
                  value:
                    oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                required:
                - label
                - value
                type: object
              type: array
            updated:
              type: boolean
          type: object
        resource_id:
          type: string
      type: object
    Appointment:
      properties:
        application_id:
          type:
          - string
          - 'null'
        candidate_id:
          type:
          - string
          - 'null'
        client_contact_id:
          type:
          - string
          - 'null'
        communication_method:
          type:
          - string
          - 'null'
        custom_array1:
          items:
            type: string
          type:
          - array
          - 'null'
        custom_array2:
          items:
            type: string
          type:
          - array
          - 'null'
        custom_array3:
          items:
            type: string
          type:
          - array
          - 'null'
        custom_array4:
          items:
            type: string
          type:
          - array
          - 'null'
        custom_array5:
          items:
            type: string
          type:
          - array
          - 'null'
        custom_date1:
          format: date
          type:
          - string
          - 'null'
        custom_date2:
          format: date
          type:
          - string
          - 'null'
        custom_date3:
          format: date
          type:
          - string
          - 'null'
        custom_date4:
          format: date
          type:
          - string
          - 'null'
        custom_date5:
          format: date
          type:
          - string
          - 'null'
        custom_date6:
          format: date
          type:
          - string
          - 'null'
        custom_datetime1:
          format: date-time
          type:
          - string
          - 'null'
        custom_datetime2:
          format: date-time
          type:
          - string
          - 'null'
        custom_datetime3:
          format: date-time
          type:
          - string
          - 'null'
        custom_datetime4:
          format: date-time
          type:
          - string
          - 'null'
        custom_datetime5:
          format: date-time
          type:
          - string
          - 'null'
        custom_datetime6:
          format: date-time
          type:
          - string
          - 'null'
        custom_float1:
          type:
          - number
          - 'null'
        custom_float2:
          type:
          - number
          - 'null'
        custom_float3:
          type:
          - number
          - 'null'
        custom_float4:
          type:
          - number
          - 'null'
        custom_float5:
          type:
          - number
          - 'null'
        custom_float6:
          type:
          - number
          - 'null'
        custom_integer1:
          type:
          - integer
          - 'null'
        custom_integer2:
          type:
          - integer
          - 'null'
        custom_integer3:
          type:
          - integer
          - 'null'
        custom_integer4:
          type:
          - integer
          - 'null'
        custom_integer5:
          type:
          - integer
          - 'null'
        custom_integer6:
          type:
          - integer
          - 'null'
        custom_text1:
          type:
          - string
          - 'null'
        custom_text10:
          type:
          - string
          - 'null'
        custom_text11:
          type:
          - string
          - 'null'
        custom_text12:
          type:
          - string
          - 'null'
        custom_text13:
          type:
          - string
          - 'null'
        custom_text14:
          type:
          - string
          - 'null'
        custom_text15:
          type:
          - string
          - 'null'
        custom_text16:
          type:
          - string
          - 'null'
        custom_text17:
          type:
          - string
          - 'null'
        custom_text18:
          type:
          - string
          - 'null'
        custom_text19:
          type:
          - string
          - 'null'
        custom_text2:
          type:
          - string
          - 'null'
        custom_text20:
          type:
          - string
          - 'null'
        custom_text21:
          type:
          - string
          - 'null'
        custom_text22:
          type:
          - string
          - 'null'
        custom_text23:
          type:
          - string
          - 'null'
        custom_text24:
          type:
          - string
          - 'null'
        custom_text25:
          type:
          - string
          - 'null'
        custom_text26:
          type:
          - string
          - 'null'
        custom_text27:
          type:
          - string
          - 'null'
        custom_text28:
          type:
          - string
          - 'null'
        custom_text29:
          type:
          - string
          - 'null'
        custom_text3:
          type:
          - string
          - 'null'
        custom_text30:
          type:
          - string
          - 'null'
        custom_text31:
          type:
          - string
          - 'null'
        custom_text32:
          type:
          - string
          - 'null'
        custom_text33:
          type:
          - string
          - 'null'
        custom_text34:
          type:
          - string
          - 'null'
        custom_text35:
          type:
          - string
          - 'null'
        custom_text36:
          type:
          - string
          - 'null'
        custom_text37:
          type:
          - string
          - 'null'
        custom_text38:
          type:
          - string
          - 'null'
        custom_text39:
          type:
          - string
          - 'null'
        custom_text4:
          type:
          - string
          - 'null'
        custom_text40:
          type:
          - string
          - 'null'
        custom_text41:
          type:
          - string
          - 'null'
        custom_text42:
          type:
          - string
          - 'null'
        custom_text43:
          type:
          - string
          - 'null'
        custom_text44:
          type:
          - string
          - 'null'
        custom_text45:
          type:
          - string
          - 'null'
        custom_text46:
          type:
          - string
          - 'null'
        custom_text47:
          type:
          - string
          - 'null'
        custom_text48:
          type:
          - string
          - 'null'
        custom_text49:
          type:
          - string
          - 'null'
        custom_text5:
          type:
          - string
          - 'null'
        custom_text50:
          type:
          - string
          - 'null'
        custom_text6:
          type:
          - string
          - 'null'
        custom_text7:
          type:
          - string
          - 'null'
        custom_text8:
          type:
          - string
          - 'null'
        custom_text9:
          type:
          - string
          - 'null'
        custom_text_block1:
          type:
          - string
          - 'null'
        custom_text_block2:
          type:
          - string
          - 'null'
        custom_text_block3:
          type:
          - string
          - 'null'
        custom_text_block4:
          type:
          - string
          - 'null'
        custom_text_block5:
          type:
          - string
          - 'null'
        custom_text_block6:
          type:
          - string
          - 'null'
        date_added:
          format: date-time
          type:
          - string
          - 'null'
        date_end:
          format: date-time
          type:
          - string
          - 'null'
        date_last_modified:
          format: date-time
          type:
          - string
          - 'null'
        date_start:
          format: date-time
          type:
          - string
          - 'null'
        date_task_complete:
          format: date
          type:
          - string
          - 'null'
        date_task_due:
          format: date-time
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        id:
          minLength: 1
          type: string
        internal_user_id:
          type:
          - string
          - 'null'
        internal_user_id2:
          type:
          - string
          - 'null'
        internal_user_id3:
          type:
          - string
          - 'null'
        internal_user_id4:
          type:
          - string
          - 'null'
        internal_user_id5:
          type:
          - string
          - 'null'
        internal_user_id6:
          type:
          - string
          - 'null'
        is_all_day:
          type:
          - boolean
          - 'null'
        is_archived:
          type:
          - boolean
          - 'null'
        is_deleted:
          description: A soft DELETE Operation is supported if the field `is_deleted = true`
          type:
          - boolean
          - 'null'
        is_private:
          type:
          - boolean
          - 'null'
        is_task:
          type:
          - boolean
          - 'null'
        job_order_id:
          type:
          - string
          - 'null'
        location:
          type:
          - string
          - 'null'
        owner_id:
          type:
          - string
          - 'null'
        placement_id:
          type:
          - string
          - 'null'
        subject:
          type:
          - string
          - 'null'
        task_complete:
          type:
          - boolean
          - 'null'
        type:
          type:
          - string
          - 'null'
      required:
      - id
    400_response_schema:
      properties:
        errors:
          items:
            properties:
              entity_id:
                description: entity id which has validation errors if available
                type:
                - string
                - 'null'
              message:
                description: description of validation error
                type:
                - string
                - 'null'
              path:
                description: path to the entity which has validation errors
                items:
                  type: string
                type:
                - array
                - 'null'
          type:
          - array
          - 'null'
        warnings:
          items:
            properties:
              entity_id:
                description: entity id which has validation warnings if available
                type:
                - string
                - 'null'
              message:
                description: description of validation warning
                type:
                - string
                - 'null'
              path:
                description: path to the entity which has validation warnings
                items:
                  type: string
                type:
                - array
                - 'null'
          type:
          - array
          - 'null'
    200_response_schema:
      properties:
        data:
          description: Contains the response entity data
          type:
          - object
          - 'null'
        errors:
          items:
            properties:
              entity_id:
                description: entity id which has validation errors if available
                type:
                - string
                - 'null'
              message:
                description: description of validation error
                type:
                - string
                - 'null'
              path:
                description: path to the entity which has validation errors
                items:
                  type: string
                type:
                - array
                - 'null'
          type: array
        resource_id:
          description: the resource id for which data is requested
          type: string
    201_response_schema:
      properties:
        message:
          type:
          - string
          - 'null'
        request_id:
          description: UUID reference for the submitted request
          type: string
    PossibleValuesGetResponse:
      properties:
        data:
          properties:
            field_name:
              description: The field name whose possible values are being returned
              type: string
            object_name:
              description: The object name for which possible values are configured
              type: string
            values:
              description: List of configured possible values, or null if none are set
              items:
                properties:
                  associationValue:
                    description: Optional association value if configured
                    type:
                    - string
                    - 'null'
                  label:
                    type: string
                  value:
                    oneOf:
                    - type: string
                    - type: number
                    - type: boolean
                required:
                - label
                - value
                type: object
              type:
              - array
              - 'null'
          type: object
        resource_id:
          description: The field name used in the request path
          type: string
      type: object
  securitySchemes:
    sense_authentication:
      flows:
        clientCredentials:
          scopes:
            N/A: The Sense API does not require a scope to be provided.
          tokenUrl: https://partner-auth.us-stage.sensehq.co/oauth2/token
      type: oauth2
    sense_bearer_auth:
      bearerFormat: JWT
      scheme: bearer
      type: http