Workable API

https://workable.readme.io/reference/
Admin
The Workable API provides programmatic access to your Workable account data, allowing you to extract...
Tokens:174,804
Snippets:1,040
Trust Score:9.9
Update:8 hours ago
Show doc for...
Tokens:
Raw
### Response JSON for GET /review-cycles/templates

Source: https://workable.readme.io/reference/performance-review-templates-list

Example response showing a single template with sections and questions. The template includes metadata for mandatory and semantic_type fields.

```json
{
  "total_count": 1,
  "templates": [
    {
      "id": "list-test-template-1",
      "title": "List Test Template",
      "updated_at": "2021-01-01T00:00:00.000Z",
      "version": 1,
      "questionnaire": {
        "sections": [
          {
            "id": "section1",
            "body": "Section 1: General Questions",
            "questions": [
              {
                "id": "question1",
                "body": "A question about performance",
                "type": "star_rated"
              },
              {
                "id": "question2",
                "body": "Overall rating",
                "type": "star_rated",
                "metadata": {
                  "mandatory": true,
                  "semantic_type": "overall_rating"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### Example response from GET /departments

Source: https://workable.readme.io/reference/departments

Example JSON response returned by the /departments endpoint. Each department object includes an `id`, `name`, and `parent_id` (null for top-level departments). The `id` should be used when creating or updating an employee via POST and PATCH endpoints.

```json
[
    {
        "id": "3ff4d641",
        "name": "Commercial",
        "parent_id": null
    },
    {
        "id": "3ff4d642",
        "name": "Customer Success",
        "parent_id": "3ff4d641"
    },
    {
        "id": "3ff4d643",
        "name": "Support",
        "parent_id": "3ff4d642"
    },
    {
        "id": "3ff4d644",
        "name": "Marketing",
        "parent_id": "3ff4d641"
    },
    {
        "id": "3ff4d645",
        "name": "Content",
        "parent_id": "3ff4d644"
    },
    {
        "id": "3ff4d646",
        "name": "Sales",
        "parent_id": "3ff4d641"
    },
    {
        "id": "3ff4d647",
        "name": "Account Executive",
        "parent_id": "3ff4d646"
    },
    {
        "id": "3ff4d648",
        "name": "Business Development",
        "parent_id": "3ff4d646"
    },
    {
        "id": "3ff4d649",
        "name": "Engineering",
        "parent_id": null
    },
    {
        "id": "3ff4d64a",
        "name": "Finance",
        "parent_id": null
    },
    {
        "id": "3ff4d64b",
        "name": "HR",
        "parent_id": null
    }
]
```

--------------------------------

### Example JSON response from GET /employees

Source: https://workable.readme.io/reference/employees

Shows the structure of the response returned by the /employees endpoint. Includes totalCount and an array of employee objects with fields such as id, firstname, lastname, email, start_date, state, employee_number, avatar, phone, address, job_title, manager_id, department_id, template_id, division_id, candidate_id, roles, legal_entity_id, work_schedule_id, and work_email. The example is truncated with a comment indicating the pattern continues.

```json
{
    "totalCount": 72,
    "employees": [
        {
            "id": "2fbc",
            "firstname": "Rex",
            "lastname": "Abernathy",
            "email": "[email protected]",
            "start_date": "2021-10-08T00:00:00.000Z",
            "state": "published",
            "employee_number": "5",
            "avatar": "https://officedroid-hris.s3.amazonaws.com/demo/avatars/men/2.jpeg?AWSAccessKeyId=AKIAZ2DSJVUU35ZD65CF&Expires=1693593051&Signature=y%2BLxX2muLIYU1u2GTSmJfigCi%2F8%3D",
            "phone": "+18579909723",
            "address": "London Road, Highfield, Sheffield, UK",
            "job_title": "Account Manager ",
            "manager_id": "2fce",
            "department_id": "3ff4d641",
            "template_id": null,
            "division_id": null,
            "candidate_id": null,
            "roles": null,
            "legal_entity_id": "e697173f-5853-48c0-8eb4-b9c67ca11a93",
            "work_schedule_id": "5c6",
            "work_email": "[email protected]"
        },
        {
            "id": "2fb6",
            "firstname": "Okey",
            "lastname": "Adams",
            "email": "[email protected]",
            "start_date": "2022-06-17T00:00:00.000Z",
            "state": "published",
            "employee_number": "41",
            "avatar": "https://officedroid-hris.s3.amazonaws.com/demo/avatars/men/20.jpeg?AWSAccessKeyId=AKIAZ2DSJVUU35ZD65CF&Expires=1693593051&Signature=RqeRPkykyiKcTVorfkOXEA7I5PQ%3D",
            "phone": "857-990-9703",
            "address": "95737 Dessie Place",
            "job_title": "Senior Account Executive ",
            "manager_id": "2fb5",
            "department_id": "3ff4d647",
            "template_id": null,
            "division_id": null,
            "candidate_id": null,
            "roles": null,
            "legal_entity_id": null,
            "work_schedule_id": null,
            "work_email": "[email protected]"
        },
    ...  // The pattern continues for other objects in the list
  ]
}
```

--------------------------------

### Example response for /timeoff/balances

Source: https://workable.readme.io/reference/timeoffbalances

Example JSON response returned by the endpoint, showing a collection of time off balances for the current cycle.

```json
{
	"balances": [
		{
			"units_available": "13.00",
			"units_carry_over_available": "0.00",
			"units_used": "0.00",
			"has_unlimited_timeoff": false,
			"category_id": "76f",
			"time_off_tracking_unit": "full_days",
			"name": "Sick leave",
			"description": "For paid time away from work due to illness or sickness."
		},
		{
			"units_available": "1.62",
			"units_carry_over_available": "0.00",
			"units_used": "0.00",
			"has_unlimited_timeoff": false,
			"category_id": "76e",
			"time_off_tracking_unit": "half_days",
			"name": "Paid time off ",
			"description": "For vacations, holidays and other paid time away from work."
		}
	]
}
```

--------------------------------

### Response example

Source: https://workable.readme.io/reference/departments-post

Example JSON response after creating a department. Returns the newly created department with id, name, parent_id, and sample fields.

```json
{
    "id": "3ff4d641",
    "name": "Commercial",
    "parent_id": null,
    "sample": false
}
```

--------------------------------

### Example response for GET /review-cycles/templates/:id

Source: https://workable.readme.io/reference/performance-review-templates-get

Shows the JSON structure returned by the endpoint, including template metadata and questionnaire sections with questions and optional metadata.

```json
{
  "id": "get-test-template-1",
  "title": "Get Test Template",
  "updated_at": "2021-01-01T00:00:00.000Z",
  "version": 1,
  "questionnaire": {
    "sections": [
      {
        "id": "section1",
        "body": "Section 1: General Questions",
        "questions": [
          {
            "id": "question1",
            "body": "A question about performance",
            "type": "star_rated"
          },
          {
            "id": "question2",
            "body": "Overall rating",
            "type": "star_rated",
            "metadata": {
              "mandatory": true,
              "semantic_type": "overall_rating"
            }
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Onboarding Completed - Example Payload

Source: https://workable.readme.io/reference/employee-events

Example JSON payload for the onboarding_completed employee event, demonstrating the structure of the data object with employee form step and signature documents.

```APIDOC
## Onboarding Completed - Example Payload

### Description
Example payload for the onboarding_completed employee event.

### Payload
```json
{
  "data": {
    "employeeFormStep": {
      "id": "4d3",
      "firstname": "Obediah",
      "lastname": "Kydde",
      "preferred_name": "Oby",
      "employee_number": "1",
      "status": "status_active",
      "address": {
        "id": "ChIJ8zG0j26ioRQRQ5IgQ3mRBjY",
        "city": "Nea Ionia",
        "bounds": {
          "northeast": "38.0450734802915,23.7490643302915",
          "southwest": "38.0423755197085,23.7463663697085"
        },
        "coords": "38.0437125, 23.7477801",
        "status": "PARTIAL_SUCCESS",
        "country": "Greece",
        "zip_code": "142 31",
        "subregion": "Attica",
        "state_code": "Attica",
        "street_name": "",
        "country_code": "GR",
        "street_number": "",
        "location_string": "Mersinis 12, Nea Ionia, Greece, 142 31"
      },
      "phone_group": [
        {
          "row_id": "4dc",
          "history_of": null,
          "is_primary": true,
          "value": {
            "phone_type": "phone_type_mobile",
            "phone": "+256 873 655 5527"
          }
        }
      ],
      "work_email": "[email protected]",
      "personal_email": [
        {
          "row_id": "4d7",
          "history_of": null,
          "is_primary": true,
          "value": "[email protected]"
        }
      ],
      "social_group": [],
      "allergies": [],
      "dietary_restrictions": [],
      "garment_size_group": [],
      "job_title": "Software Engineer",
      "start_date": "2022-09-13T16:56:33.000Z",
      "legal_entity": "6dd32255-668e-4d7a-9542-086fd65c41b0",
      "department": "4d3",
      "marital_status_group": {
        "marital_status": "marital_status_married"
      },
      "phone_type": "phone_type_mobile",
      "phone": "+256 873 655 5527",
      "avatar": "officedroid/uploads/1/avatar.jpg"
    },
    "signatureDocuments": {
      "employeeDocuments": [
        {
          "id": "4d5",
          "filepath": "https://subdomain.workable.com/spi/v3/documents/4d5"
        }
      ]
    }
  },
  "id": "4d3",
  "resource_type": "employee",
  "event_type": "onboarding_completed",
  "fired_at": "2024-01-08T14:01:06.217Z"
}
```
```

--------------------------------

### Request body example

Source: https://workable.readme.io/reference/departments-post

Example JSON body for creating a department. The 'name' field is required; 'parent_id' is optional and null for a top-level department.

```json
{
    "name": "Commercial",
    "parent_id": null
}
```

--------------------------------

### Response example

Source: https://workable.readme.io/reference/departments-put

Example JSON response after updating a department. The response includes the updated department fields: id, name, parent_id, and sample (boolean indicating if it's a sample created department).

```json
{
    "id": "3ff4d641",
    "name": "New Commercial name",
    "parent_id": "3ff4d64b",
    "sample": false
}
```

--------------------------------

### Request body example

Source: https://workable.readme.io/reference/departments-put

Example JSON body for updating a department. The id identifies the department, name is the new name, and parent_id can be changed to move the department under a new parent or set to null to make it a root department.

```json
{
    "id": "3ff4d641",
    "name": "New Commercial name",
    "parent_id": "3ff4d64b"
}
```

--------------------------------

### Example Payload - Employee Created (JSON)

Source: https://workable.readme.io/reference/employee-events

Example JSON payload for the employee_created event, containing minimal employee information such as id, names, job title, department, start date, phone and email groups, legal entity, and employee number. The event type is 'employee_created' and includes a fired_at timestamp.

```json
{
  "data": {
    "id": "4d3",
    "status": "status_draft",
    "lastname": "Kydde",
    "firstname": "Obediah",
    "job_title": "Software Engineer",
    "department": "4d3",
    "start_date": "2022-09-13T16:56:33.000Z",
    "phone_group": [
      {
        "value": {
          "phone": "+256 873 655 5527",
          "phone_type": "phone_type_mobile"
        },
        "row_id": "4dc",
        "history_of": null,
        "is_primary": true
      }
    ],
    "legal_entity": "6dd32255-668e-4d7a-9542-086fd65c41b0",
    "personal_email": [
      {
        "value": "[email protected]",
        "row_id": "4d7",
        "history_of": null,
        "is_primary": true
      }
    ],
    "employee_number": "1"
  },
  "id": "4d3",
  "resource_type": "employee",
  "event_type": "employee_created",
  "fired_at": "2024-01-08T14:01:06.217Z"
}
```

--------------------------------

### Example request body for POST /requisitions

Source: https://workable.readme.io/reference/requisitions-post

JSON body for creating a requisition. Includes job_id, department_id, owner_id, hiring_manager_id, code, employment_type, reason, plan_date, and requisition_attributes.

```json
{
  "job_id": "AbC123",
  "department_id": "dEf456",
  "owner_id": "gHi789",
  "hiring_manager_id": "jKl012",
  "code": { "value": "REQ-001" },
  "employment_type": "Full-time",
  "reason": "new_hire",
  "plan_date": "2026-06",
  "requisition_attributes": [
    { "slug": "cost_center", "value": "Engineering" },
    { "slug": "hiring_reason", "value": "Replacement" },
    { "slug": "budget", "value": { "amount": "75000", "frequency": "annual", "currency": "USD" } },
    { "slug": "required_skills", "value": [1, 2, 3] }
  ]
}
```

--------------------------------

### Employee Published - Example Payload

Source: https://workable.readme.io/reference/employee-events

Example payload for the employee_published event, which is triggered when an employee is published.

```APIDOC
## Employee Published - Example Payload

### Description
Example payload for the employee_published event, which is triggered when an employee is published.

### Example Payload
```json
{
  "data": {
    "workEmail": "[email protected]"
  },
  "id": "4d3",
  "resource_type": "employee",
  "event_type": "employee_published",
  "fired_at": "2024-01-08T14:01:06.217Z"
}
```
```

--------------------------------

### Example answers payload for posting candidate answers

Source: https://workable.readme.io/reference/job-candidates-create

JSON example showing how to structure the answers list for different question types when creating a candidate. Includes free text, boolean, multiple choice, date, numeric, and file answers. The file answer can be provided via a file_url or as a base64-encoded object with name and data keys.

```json
{
  "answers": [
    {
      "question_key": "dc3e",
      "body": "Sublime Editor"
    },
    {
      "question_key": "2d30",
      "checked": true
    },
    {
      "question_key": "dc3f",
      "choices": ["e2b", "e2d"]
    },
    {
      "question_key": "dc3b",
      "date": "2017-01-28"
    },
    {
      "question_key": "dc3c",
      "value": 21.87
    },
    {
      "question_key": "dc3d",
      "file": {
        "name": "answer.pdf",
        "data": "SGVsbG8h....SbGh"
      }
    }
  ]
}
```

--------------------------------

### Timeoff Updated (Approved) - Example Payload

Source: https://workable.readme.io/reference/employee-events

Example payload for the timeoff_request_approved event, which is triggered when a timeoff request is approved.

```APIDOC
## Timeoff Updated (Approved) - Example Payload

### Description
Example payload for the timeoff_request_approved event, which is triggered when a timeoff request is approved.

### Example Payload
```json
{
  "data": {
    "id": "3647",
    "state": "approved",
    "to_date": "2024-05-17T00:00:00.000",
    "from_date": "2024-05-15T00:00:00.000",
    "half_days": [],
    "updated_at": "2024-05-15T12:58:55.491Z",
    "updated_by": "Nikos Dimos",
    "category_name": "Paid time off",
    "formatted_period": "15 May 2024 - 17 May 2024",
    "requesting_total": 3,
    "timeoff_tracking_unit": "full_days"
  },
  "id": "4dd",
  "resource_type": "employee",
  "event_type": "timeoff_request_approved",
  "fired_at": "2024-05-15T12:58:59.365Z"
}
```
```

--------------------------------

### Timeoff Updated (Reverted) - Example Payload

Source: https://workable.readme.io/reference/employee-events

Example payload for the timeoff_request_reverted event, which is triggered when a timeoff request is reverted or canceled.

```APIDOC
## Timeoff Updated (Reverted) - Example Payload

### Description
Example payload for the timeoff_request_reverted event, which is triggered when a timeoff request is reverted or canceled.

### Example Payload
```json
{
  "data": {
    "id": "3648",
    "state": "canceled",
    "to_date": "2024-06-13T00:00:00.000",
    "from_date": "2024-06-12T00:00:00.000",
    "half_days": [],
    "updated_at": "2024-05-15T13:03:47.059Z",
    "updated_by": "Nikos Dimos",
    "category_name": "Sick leave",
    "formatted_period": "12 June 2024 - 13 June 2024",
    "requesting_total": 2,
    "timeoff_tracking_unit": "half_days"
  },
  "id": "4dd",
  "resource_type": "employee",
  "event_type": "timeoff_request_reverted",
  "fired_at": "2024-05-15T13:03:49.764Z"
}
```
```

--------------------------------

### Request Body Example

Source: https://workable.readme.io/reference/revert-disqualification-candidate

Example JSON body for the revert disqualification request. The member_id is required and identifies the member reverting the disqualification.

```json
{ 
  "member_id": "13e0eb0e"
}
```

--------------------------------

### curl request with image_url (Bash)

Source: https://workable.readme.io/reference/job-candidates-create

Example curl command to create a candidate with a photo using `image_url`. Requires replacing `{subdomain}`, `{shortcode}`, and `{access_token}` with your account subdomain, job shortcode, and OAuth token (with `w_candidates` scope).

```Bash
curl -X POST "https://{subdomain}.workable.com/spi/v3/accounts/{subdomain}/jobs/{shortcode}/candidates" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "sourced": true,
    "candidate": {
      "name": "Jane Doe",
      "email": "[email protected]",
      "image_url": "https://example.com/photo.jpg",
      "image_source": "candidate"
    }
  }'
```

--------------------------------

### Employee Published - Example Payload

Source: https://workable.readme.io/reference/employee-events

Example JSON payload for the 'employee_published' event. Contains the employee's work email and event metadata.

```json
{
  "data": {
    "workEmail": "[email protected]"
  },
  "id": "4d3",
  "resource_type": "employee",
  "event_type": "employee_published",
  "fired_at": "2024-01-08T14:01:06.217Z"
}
```

--------------------------------

### Example request with account token

Source: https://workable.readme.io/reference/timeoffrequests

Shows the JSON body for a time off request using an account token. Requires employee_id and member_id. member_id identifies the member context.

```json
{
  "employee_id": "4d3",
  "member_id": "188948e7-28fb-460e-85fe-79de4cd7926f:1839d70f-7caa-4f02-9e3f-c46cced76f5b",
  "category_id": "4d3",
  "from_date": "2024-03-26T12:00:00.000",
  "to_date": "2024-03-28T12:00:00.000",
  "note": "Optional note"
}
```

--------------------------------

### Timeoff Updated (Approved) - Example Payload

Source: https://workable.readme.io/reference/employee-events

Example JSON payload for the 'timeoff_request_approved' event. Contains timeoff request details such as state, dates, and category.

```json
{
  "data": {
    "id": "3647",
    "state": "approved",
    "to_date": "2024-05-17T00:00:00.000",
    "from_date": "2024-05-15T00:00:00.000",
    "half_days": [],
    "updated_at": "2024-05-15T12:58:55.491Z",
    "updated_by": "Nikos Dimos",
    "category_name": "Paid time off",
    "formatted_period": "15 May 2024 - 17 May 2024",
    "requesting_total": 3,
    "timeoff_tracking_unit": "full_days"
  },
  "id": "4dd",
  "resource_type": "employee",
  "event_type": "timeoff_request_approved",
  "fired_at": "2024-05-15T12:58:59.365Z"
}
```

--------------------------------

### POST /employees Example Request Body (JSON)

Source: https://workable.readme.io/reference/create-employee

Example JSON body for creating an employee via the POST /employees endpoint. Requires the w_employees scope, which can be enabled through the Integrations section in the Settings menu. The body includes fields for personal details, employment, salary, and identification numbers.

```json
{  
    "member_id": "9ab4b",
    "state": "draft",
    "employee":
    {
        "firstname": "Zinedin",
        "lastname": "Doe",
        "preferred_name": "Zizu",
        "country": "GB",
        "address":
        {
            "locationString": "Kifisias 95, Athens, Greece"
        },
        "gender": "gender_male",
        "birthdate": "1987-09-23T00:00:00.000Z",
        "marital_status_group":
        {
            "marital_status": "marital_status_married"
        },
        "phone_group":
        [
            {
                "value":
                {
                    "phone_type": "phone_type_mobile",
                    "phone": "+18579909723"
                }
            }
        ],
        "work_email": "[email protected]",
        "personal_email":
        [
            {
                "value": "[email protected]"
            }
        ],
        "chat_group":
        [
            {
                "value":
                {
                    "chat_type": "chat_type_slack",
                    "chat_username": "zizu"
                }
            },
            {
                "value":
                {
                    "chat_type": "chat_type_google_meet",
                    "chat_username": "zizu"
                }
            }
        ],
        "social_group":
        [
            {
                "value":
                {
                    "social_type": "social_type_facebook",
                    "social_url": "https://facebook.com/im/zizu"
                }
            }
        ],
        "job_title": "Account Manager ",
        "hire_date": "2021-10-01T00:00:00.000Z",
        "start_date": "2021-10-08T00:00:00.000Z",
        "legal_entity": "e697173f-5853-48c0-8eb4-b9c67ca11a93",
        "department": "3ff4d641",
        "reports_to": "2fce",
        "employment_group":
        [
            {
                "value":
                {
                    "employment_effective_date": "2021-10-08T00:00:00.000Z",
                    "employment_status": "employement_type_full_time"
                }
            }
        ],
        "work_schedule": "5c6",
        "salary_group":
        [
            {
                "value":
                {
                    "salary_effective_date": "2021-10-08T00:00:00.000Z",
                    "salary_pay_type": "salary_pay_type_salary",
                    "salary_pay_rate":
                    {
                        "amount": 90000,
                        "currency": "USD",
                        "frequency": "year"
                    },
                    "salary_pay_schedule": "salary_pay_schedule_every_15_days",
                    "salary_overtime_status": "salary_overtime_status_exempt",
                    "salary_justification": "salary_justification_new_hire"
                }
            }
        ],
        "bank_details_group":
        {
            "bank_details_bank_name": "Sterling",
            "bank_details_iban": "STR123456789",
            "bank_details_account_number": "234434"
        },
        "social_security_number_group":
        {
            "social_security_number_number": "XI5542",
            "social_security_number_issue_date": "1992-05-05T00:00:00.000Z"
        },
        "national_identification_number_group":
        {
            "national_identification_number_number": "XI5542",
            "national_identification_number_issue_date": "1992-05-05T00:00:00.000Z"
        },
        "social_insurance_number_group":
        [
            {
                "value":
                {
                    "social_insurance_number_number": "XI5543",
                    "social_insurance_number_issue_date": "1992-05-05T00:00:00.000Z"
                }
            }
        ],
        "tax_identification_number_group":
        {
            "tax_identification_number_number": "IX444301",
            "tax_identification_number_issue_date": "1992-05-05T00:00:00.000Z"
        },
        "nationality": "GB",
        "citizenship":

```

--------------------------------

### Timeoff Updated (Reverted) - Example Payload

Source: https://workable.readme.io/reference/employee-events

Example JSON payload for the 'timeoff_request_reverted' event. Contains timeoff request details with state 'canceled' and half-day tracking.

```json
{
  "data": {
    "id": "3648",
    "state": "canceled",
    "to_date": "2024-06-13T00:00:00.000",
    "from_date": "2024-06-12T00:00:00.000",
    "half_days": [],
    "updated_at": "2024-05-15T13:03:47.059Z",
    "updated_by": "Nikos Dimos",
    "category_name": "Sick leave",
    "formatted_period": "12 June 2024 - 13 June 2024",
    "requesting_total": 2,
    "timeoff_tracking_unit": "half_days"
  },
  "id": "4dd",
  "resource_type": "employee",
  "event_type": "timeoff_request_reverted",
  "fired_at": "2024-05-15T13:03:49.764Z"
}
```

--------------------------------

### Complete candidate creation JSON example

Source: https://workable.readme.io/reference/job-candidates-create

A complete JSON payload for creating a candidate, including all optional fields such as education, experience, answers, skills, social profiles, and more. Use this as a template for the POST /jobs/:shortcode/candidates request body.

```json
{
  "sourced": true,
  "candidate": {
    "name": "Jj Botha",
    "firstname": "Jj",
    "lastname": "Botha",
    "headline": "Professional Administration Manager",
    "summary": "A focussed, results-driven team player with many year experience in the field. Working my way up to management level, I have experience of every aspect of this role. I understand the challenges it brings, and have a proven track record of providing solutions.",
    "address": "25772 Gustave Shore, Iowa, USA",
    "phone": "1-859-557-6573",
    "email": "[email protected]",
    "cover_letter": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",

    "education_entries": [
      { "degree": "MBA", "school": "University of Pennsylvania", "field_of_study": null, "start_date": "2008-03-01", "end_date": "2011-03-30" },
      { "degree": "B.S.", "school": "University of Chicago", "field_of_study": "Marketing Communication & Economics", "start_date": "2004-09-01", "end_date": "2007-03-30" }
    ],

    "experience_entries": [
      {
        "title": "Sales Director",
        "summary": null,
        "start_date": "2011-03-01",
        "end_date": "2014-03-30",
        "current": false,
        "company": "Vox Mobile",
        "industry": "Telecommunications"
      }
    ],

    "answers": [
      {
        "question_key": "2128d717",
        "body": "Planning"
      },
      {
        "question_key": "3399e6cd",
        "choices": ["1e477229"]
      }
    ],

    "skills": [ "Travel Planning", "Problem Solving"],
    "social_profiles": [
        {
          "type": "twitter",
          "name": "Twitter",
          "username": "jj_botha",
          "url": "http://www.twitter.com/jj_botha"
        },
        {
          "type": "linkedin",
          "name": "LinkedIn",
          "url": "http://www.linkedin.com/in/jj_botha"
        },
        {
          "type": "googleplus",
          "url": "https://plus.google.com/6908286706342698"
        }
    ]
  }
}
```

--------------------------------

### Upload documents for an employee - JSON body

Source: https://workable.readme.io/reference/employeesiddocuments-1

Example JSON body for the POST request. The `url` must be a complete URL where the file is hosted, with a TTL of 1 hour. The `name` is the file/document name.

```json
{
   "member_id": "9ab4b",
    "documents": [
        {
            "url": "https://cdn.mos.cms.futurecdn.net/HjFE8NKWuCmgfHCcndJ3rK.jpg",
            "name": "Custom document"
        }
    ]
}
```

--------------------------------

### Example request body for disqualifying a candidate

Source: https://workable.readme.io/reference/disqualify-candidate

A complete request body example for the POST /candidates/:id/disqualify endpoint. It includes the required member_id and the disqualification_reason (deprecated) field.

```json
{ 
  "member_id": "13e0eb0e", 
  "disqualification_reason": "Very tardy" 
}
```

--------------------------------

### Example request with user token

Source: https://workable.readme.io/reference/timeoffrequests

Shows the JSON body for a time off request using a user token. employee_id and member_id are optional and derived from the authenticated user when omitted.

```json
{
  "category_id": "4d3",
  "from_date": "2024-03-26T12:00:00.000",
  "to_date": "2024-03-28T12:00:00.000",
  "note": "Optional note"
}
```

--------------------------------

### Create candidate with base64 image (JSON)

Source: https://workable.readme.io/reference/job-candidates-create

Example JSON payload for creating a candidate with a photo encoded in base64. The `image` object includes the file name and base64 data.

```JSON
{
  "sourced": true,
  "candidate": {
    "name": "Jane Doe",
    "email": "[email protected]",
    "image": {
      "name": "photo.jpg",
      "data": "SGVsbG8h"
    },
    "image_source": "candidate"
  }
}
```
Tokens:
Raw