Work Market Assignments API

The Assignments API from Work Market — 39 operation(s) for assignments.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

work-market-assignments-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  description: Employer APIs
  version: v1
  title: Swagger spec for Work Market API v1 Addressbook Assignments 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: Assignments
paths:
  /v1/employer/assignments/accept_bonus:
    post:
      tags:
      - Assignments
      summary: Accept bonus request
      description: ''
      operationId: acceptBonusPostAction
      parameters:
      - name: id
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/accept_budget_increase:
    post:
      tags:
      - Assignments
      summary: Accept budget increase request
      description: ''
      operationId: acceptBudgetIncreasePostAction
      parameters:
      - name: id
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/accept_expense_reimbursement:
    post:
      tags:
      - Assignments
      summary: Accept expense reimbursement
      description: ''
      operationId: acceptExpenseReimbursementPostAction
      parameters:
      - name: id
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/accept_reschedule:
    post:
      tags:
      - Assignments
      summary: Accept reschedule request
      description: ''
      operationId: acceptReschedulePostAction
      parameters:
      - name: id
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/add_note:
    post:
      tags:
      - Assignments
      summary: Add message
      description: ''
      operationId: addNote
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: content
        in: query
        required: false
        type: string
      - name: is_private
        in: query
        required: false
        type: boolean
      - name: is_privileged
        in: query
        required: false
        type: boolean
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/approve_payment:
    post:
      tags:
      - Assignments
      summary: Approve payment
      description: ''
      operationId: approvePayment
      parameters:
      - name: id
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/attachments/add:
    post:
      tags:
      - Assignments
      summary: Add document
      description: ''
      operationId: addDocument
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: attachment
        in: query
        required: false
        type: string
      - name: filename
        in: query
        required: false
        type: string
      - name: description
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/Attachment'
  /v1/employer/assignments/attachments/get:
    get:
      tags:
      - Assignments
      summary: Get attachment
      description: ''
      operationId: getAttachment
      parameters:
      - name: uuid
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/Attachment'
  /v1/employer/assignments/attachments/list:
    get:
      tags:
      - Assignments
      summary: List attachments
      description: ''
      operationId: listAttachments
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: closeout
        in: query
        required: false
        type: boolean
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                type: array
                items:
                  $ref: '#/definitions/Attachment'
  /v1/employer/assignments/attachments/remove:
    post:
      tags:
      - Assignments
      summary: Remove attachment
      description: ''
      operationId: removeAttachment
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: uuid
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/cancel:
    post:
      tags:
      - Assignments
      summary: Cancel assignment
      description: ''
      operationId: cancel
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: note
        in: query
        required: false
        type: string
      - name: amount
        in: query
        required: false
        type: number
        format: double
      - name: reason
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/create:
    post:
      tags:
      - Assignments
      summary: Create new assignment
      description: ''
      operationId: create
      parameters:
      - name: template_id
        in: query
        required: false
        type: string
      - name: external_work_id
        in: query
        required: false
        type: integer
        format: int64
      - name: title
        in: query
        required: false
        type: string
      - name: description
        in: query
        required: false
        type: string
      - name: instructions
        in: query
        required: false
        type: string
      - name: private_instructions
        in: query
        required: false
        type: boolean
      - name: desired_skills
        in: query
        required: false
        type: string
      - name: industry_id
        in: query
        required: false
        type: integer
        format: int64
      - name: owner_id
        in: query
        required: false
        type: string
      - name: owner_email
        in: query
        required: false
        type: string
      - name: support_contact_id
        in: query
        required: false
        type: string
      - name: support_contact_email
        in: query
        required: false
        type: string
      - name: client_id
        in: query
        required: false
        type: integer
        format: int64
      - name: project_id
        in: query
        required: false
        type: integer
        format: int64
      - name: scheduled_start
        in: query
        required: false
        type: integer
        format: int64
      - name: scheduled_start_date
        in: query
        required: false
        type: string
      - name: scheduled_end
        in: query
        required: false
        type: integer
        format: int64
      - name: scheduled_end_date
        in: query
        required: false
        type: string
      - name: multiple_day_schedule
        in: query
        required: false
        type: boolean
      - name: pricing_mode
        in: query
        required: false
        type: string
      - name: pricing_type
        in: query
        required: false
        type: string
      - name: pricing_flat_price
        in: query
        required: false
        type: number
        format: double
      - name: pricing_per_hour_price
        in: query
        required: false
        type: number
        format: double
      - name: pricing_max_number_of_hours
        in: query
        required: false
        type: number
        format: double
      - name: pricing_per_unit_price
        in: query
        required: false
        type: number
        format: double
      - name: pricing_max_number_of_units
        in: query
        required: false
        type: number
        format: double
      - name: pricing_initial_per_hour_price
        in: query
        required: false
        type: number
        format: double
      - name: pricing_initial_number_of_hours
        in: query
        required: false
        type: number
        format: double
      - name: pricing_additional_per_hour_price
        in: query
        required: false
        type: number
        format: double
      - name: pricing_max_blended_number_of_hours
        in: query
        required: false
        type: number
        format: double
      - name: location_offsite
        in: query
        required: false
        type: string
      - name: location_id
        in: query
        required: false
        type: integer
        format: int64
      - name: location_name
        in: query
        required: false
        type: string
      - name: location_number
        in: query
        required: false
        type: string
      - name: location_instructions
        in: query
        required: false
        type: string
      - name: location_address1
        in: query
        required: false
        type: string
      - name: location_address2
        in: query
        required: false
        type: string
      - name: location_city
        in: query
        required: false
        type: string
      - name: location_state
        in: query
        required: false
        type: string
      - name: location_zip
        in: query
        required: false
        type: string
      - name: location_country
        in: query
        required: false
        type: string
      - name: location_dress_code
        in: query
        required: false
        type: string
      - name: location_type
        in: query
        required: false
        type: string
      - name: requirement_set_ids
        in: query
        required: false
        type: array
        items:
          type: integer
          format: int64
        collectionFormat: multi
      - name: send_radius
        in: query
        required: false
        type: integer
        format: int64
      - name: resource_id
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: assign_to_first_to_accept
        in: query
        required: false
        type: boolean
      - name: auto_invite
        in: query
        required: false
        type: boolean
      - name: show_in_work_feed
        in: query
        required: false
        type: boolean
      - name: payment_terms_days
        in: query
        required: false
        type: integer
        format: int32
      - name: disable_address_correction
        in: query
        required: false
        type: boolean
      - name: deliverables_instructions
        in: query
        required: false
        type: string
      - name: deliverables_due_date
        in: query
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/AssignmentCreationResponse'
  /v1/employer/assignments/decline_bonus:
    post:
      tags:
      - Assignments
      summary: Decline bonus request
      description: ''
      operationId: declineBonusPostAction
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: reason
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/decline_budget_increase:
    post:
      tags:
      - Assignments
      summary: Decline budget increase request
      description: ''
      operationId: declineBudgetIncreasePostAction
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: reason
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/decline_expense_reimbursement:
    post:
      tags:
      - Assignments
      summary: Decline expense reimbursement request
      description: ''
      operationId: declineExpenseReimbursementPostAction
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: reason
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/decline_reschedule:
    post:
      tags:
      - Assignments
      summary: Decline reschedule request
      description: ''
      operationId: declineReschedulePostAction
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: reason
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/delete:
    post:
      tags:
      - Assignments
      summary: Delete assignment
      description: ''
      operationId: delete
      parameters:
      - name: id
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/get:
    get:
      tags:
      - Assignments
      summary: Get assignment details
      description: ''
      operationId: get
      parameters:
      - name: id
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/AssignmentDetails'
  /v1/employer/assignments/increase_spendlimit:
    post:
      tags:
      - Assignments
      summary: Increase spend limit
      description: ''
      operationId: increaseSpendLimit
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: type
        in: query
        required: false
        type: string
      - name: pricing_mode
        in: query
        required: false
        type: string
      - name: flat_price
        in: query
        required: false
        type: number
        format: double
      - name: per_hour_price
        in: query
        required: false
        type: number
        format: double
      - name: max_number_of_hours
        in: query
        required: false
        type: number
        format: double
      - name: per_unit_price
        in: query
        required: false
        type: number
        format: double
      - name: max_number_of_units
        in: query
        required: false
        type: number
        format: double
      - name: initial_per_hour_price
        in: query
        required: false
        type: number
        format: double
      - name: initial_number_of_hours
        in: query
        required: false
        type: number
        format: double
      - name: additional_per_hour_price
        in: query
        required: false
        type: number
        format: double
      - name: max_blended_number_of_hours
        in: query
        required: false
        type: number
        format: double
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
      deprecated: true
  /v1/employer/assignments/list:
    get:
      tags:
      - Assignments
      summary: List assignments
      description: ''
      operationId: listAssignmentsAction
      parameters:
      - name: status
        in: query
        required: false
        type: string
      - name: labels
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: client_id
        in: query
        required: false
        type: integer
        format: int64
      - name: start
        in: query
        required: false
        type: integer
        format: int32
      - name: limit
        in: query
        required: false
        type: integer
        format: int32
      - name: sort_dir
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                type: object
                properties:
                  count:
                    type: integer
                    format: int32
                  data:
                    type: array
                    items:
                      $ref: '#/definitions/AssignmentListItem'
                  limit:
                    type: integer
                    format: int32
                  start:
                    type: integer
                    format: int32
                  totalResults:
                    type: integer
                    format: int32
  /v1/employer/assignments/list_exceptions:
    get:
      tags:
      - Assignments
      summary: List exception-status assignments
      description: ''
      operationId: listAssignmentExceptionsAction
      parameters:
      - name: start
        in: query
        required: false
        type: integer
        format: int32
      - name: limit
        in: query
        required: false
        type: integer
        format: int32
      - name: exception_type
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                type: object
                properties:
                  count:
                    type: integer
                    format: int32
                  data:
                    type: array
                    items:
                      $ref: '#/definitions/AssignmentListItem'
                  limit:
                    type: integer
                    format: int32
                  start:
                    type: integer
                    format: int32
                  totalResults:
                    type: integer
                    format: int32
  /v1/employer/assignments/list_updated:
    get:
      tags:
      - Assignments
      summary: List updated assignments
      description: ''
      operationId: listUpdatedAction
      parameters:
      - name: status
        in: query
        required: false
        type: string
      - name: modified_since
        in: query
        required: false
        type: integer
        format: int64
      - name: start
        in: query
        required: false
        type: integer
        format: int32
      - name: limit
        in: query
        required: false
        type: integer
        format: int32
      - name: sort_dir
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                type: object
                properties:
                  count:
                    type: integer
                    format: int32
                  data:
                    type: array
                    items:
                      $ref: '#/definitions/AssignmentListItem'
                  limit:
                    type: integer
                    format: int32
                  start:
                    type: integer
                    format: int32
                  totalResults:
                    type: integer
                    format: int32
  /v1/employer/assignments/offers/accept:
    post:
      tags:
      - Assignments
      summary: Accept offer/application
      description: ''
      operationId: acceptOffer
      parameters:
      - name: id
        in: query
        required: false
        type: integer
        format: int64
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/offers/decline:
    post:
      tags:
      - Assignments
      summary: Decline offer/application
      description: ''
      operationId: declineOffer
      parameters:
      - name: id
        in: query
        required: false
        type: integer
        format: int64
      - name: reason
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/questions/answer:
    post:
      tags:
      - Assignments
      summary: Answer question
      description: ''
      operationId: answerQuestion
      parameters:
      - name: id
        in: query
        required: false
        type: integer
        format: int64
      - name: answer
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/rate_assignment:
    post:
      tags:
      - Assignments
      summary: Rate assignments
      description: ''
      operationId: saveSinglePendingResourceRatingData
      parameters:
      - name: id
        in: query
        required: true
        type: string
      - name: value
        in: query
        required: false
        type: integer
        format: int32
      - name: quality
        in: query
        required: false
        type: integer
        format: int32
      - name: professionalism
        in: query
        required: false
        type: integer
        format: int32
      - name: communication
        in: query
        required: false
        type: integer
        format: int32
      - name: review
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/reject_payment:
    post:
      tags:
      - Assignments
      summary: Reject payment
      description: ''
      operationId: rejectPayment
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: note
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/reschedule:
    post:
      tags:
      - Assignments
      summary: Request reschedule
      description: ''
      operationId: reschedule
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: scheduled_start
        in: query
        required: false
        type: string
      - name: scheduled_end
        in: query
        required: false
        type: string
      - name: multiple_day_schedule
        in: query
        required: false
        type: boolean
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/statuses:
    get:
      tags:
      - Assignments
      summary: List statuses
      description: ''
      operationId: listAssignmentStatusesAction
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                type: array
                items:
                  $ref: '#/definitions/Status'
  /v1/employer/assignments/templates/get:
    get:
      tags:
      - Assignments
      summary: Get template
      description: ''
      operationId: getAssignmentTemplateAction
      parameters:
      - name: id
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/Template'
  /v1/employer/assignments/templates/list:
    get:
      tags:
      - Assignments
      summary: List templates
      description: ''
      operationId: listAssignmentTemplatesAction
      parameters:
      - name: client_id
        in: query
        required: false
        type: integer
        format: int64
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                type: array
                items:
                  $ref: '#/definitions/TemplateListItem'
  /v1/employer/assignments/void:
    post:
      tags:
      - Assignments
      summary: Void assignment
      description: ''
      operationId: doVoid
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: note
        in: query
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/{assignmentId}/unassign:
    post:
      tags:
      - Assignments
      summary: Unassign worker
      description: ''
      operationId: unassignAssignment
      produces:
      - application/json
      parameters:
      - name: assignmentId
        in: path
        required: true
        type: string
      - name: cancellation_reason
        in: query
        required: true
        type: string
      - name: rollback_to_original_price
        in: query
        required: true
        type: boolean
      - name: note
        in: query
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/{id}/custom_fields:
    post:
      tags:
      - Assignments
      summary: Update custom fields
      description: ''
      operationId: editAssignmentFieldsAction
      parameters:
      - name: id
        in: path
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            type: object
            properties:
              meta:
                $ref: '#/definitions/v1Meta'
              response:
                $ref: '#/definitions/v1Status'
  /v1/employer/assignments/{id}/edit:
    post:
      tags:
      - Assignments
      summary: Edit assignment
      description: ''
      operationId: editAssignmentAction
      parameters:
      - name: id
        in: path
        required: true
        type: string
      - name: title
        in: query
        required: false
        type: string
      - name: description
        in: query
        required: false
        type: string
      - name: instructions
        in: query
        required: false
        type: string
      - name: desired_skills
        in: query
        required: false
        type: string
      - name: industry_id
        in: query
        required: false
        type: integer
        format: int64
      - name: owner_id
        in: query
        required: false
        type: string
      - name: owner_email
        in: query
        required: false
        type: string
      - name: support_contact_id
        in: query
        required: false
        type: string
      - name: support_contact_email
        in: query
        required: 

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/work-market/refs/heads/main/openapi/work-market-assignments-api-openapi.yml