Work Market Custom Fields API

The Custom Fields API from Work Market — 1 operation(s) for custom fields.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

work-market-custom-fields-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  description: Employer APIs
  version: v1
  title: Swagger spec for Work Market API v1 Addressbook Custom Fields API
  termsOfService: https://developer.workmarket.com/tos
  contact:
    name: Work Market API Team
    url: https://developer.workmarket.com
    email: api@workmarket.com
  license:
    name: Company Licence
    url: https://developer.workmarket.com/licenses/LICENSE-2.0.html
host: www.workmarket.com
basePath: /
schemes:
- https
tags:
- name: Custom Fields
paths:
  /v1/api/assignments/customfields/list:
    get:
      tags:
      - Custom Fields
      summary: List custom fields
      description: ''
      operationId: list
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                type: array
                items:
                  $ref: '#/definitions/CustomFieldGroup'
definitions:
  CustomFieldGroup:
    type: object
    properties:
      id:
        type: integer
        format: int64
        readOnly: true
      name:
        type: string
        readOnly: true
      fields:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/CustomField'
      required:
        type: boolean
        readOnly: true
  v1Meta:
    type: object
    properties:
      errors:
        type: array
        items:
          type: object
      status_code:
        type: integer
        format: int32
      version:
        type: integer
        format: int32
      requestId:
        type: string
      execution_time:
        type: number
        format: double
      timestamp:
        type: integer
        format: int64
  CustomField:
    type: object
    properties:
      id:
        type: integer
        format: int64
        readOnly: true
      name:
        type: string
        readOnly: true
      default:
        type: string
        readOnly: true
      required:
        type: boolean
        readOnly: true
      value:
        type: string
        readOnly: true
      type:
        type: string
        readOnly: true