### Get Data from Dataset - cURL Example

Source: https://documentation.bamboohr.com/reference/get-data-from-dataset-1

This example demonstrates how to make a POST request to the BambooHR API to retrieve data from a dataset using cURL. It includes setting the request URL, accept, and content-type headers.

```Shell
curl --request POST \
     --url https://example.bamboohr.com/api/v1/datasets/datasetName \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

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

### Get Job Summaries - cURL Request

Source: https://documentation.bamboohr.com/reference/get-job-summaries-1

Example of how to retrieve a list of job summaries using a cURL request. This command demonstrates the GET method, the API endpoint, and the necessary 'accept' header for a JSON response.

```Shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/applicant_tracking/jobs \
     --header 'accept: application/json'
```

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

### Get Goals Sample Request URL

Source: https://documentation.bamboohr.com/reference/get-goals-1

Provides a sample URL for the Get Goals API endpoint, demonstrating the structure for retrieving an employee's goals.

```text
https://api.bamboohr.com/api/gateway.php/samplecompany/v1/performance/employees/1234/goals
```

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

### Get Goals Filters - Sample Request URL

Source: https://documentation.bamboohr.com/reference/goals-1

A sample URL for the Get Goals Filters API endpoint, showing the base URL structure and placeholders for company domain and employee ID.

```Text
https://api.bamboohr.com/api/v1/performance/employees/123/goals/filters
```

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

### Get Goal Comments - Sample Request URL

Source: https://documentation.bamboohr.com/reference/get-goal-comments-1

An example of the URL structure used to request goal comments from the BambooHR API, including placeholders for company domain, employee ID, and goal ID.

```text
https://api.bamboohr.com/api/gateway.php/samplecompany/v1/performance/employees/1234/goals/24/comments
```

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

### Get Goals Filters - cURL Request

Source: https://documentation.bamboohr.com/reference/goals-1

Example cURL request to fetch goal filters for a specific employee. This demonstrates the HTTP method, URL structure, and required headers for authentication and content type.

```Shell
curl --request GET \
     --url https://api.bamboohr.com/api/v1/performance/employees/123/goals/filters \
     --header 'accept: application/json'
```

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

### Get Employee Directory - cURL Request Example

Source: https://documentation.bamboohr.com/reference/get-employees-directory

This cURL command demonstrates how to make a GET request to the BambooHR API to retrieve the employee directory. It specifies the endpoint URL and sets the `accept` header to `application/json` to receive the response in JSON format.

```shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/employees/directory \
     --header 'accept: application/json'
```

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

### Get Field Options - cURL Request Example

Source: https://documentation.bamboohr.com/reference/18e680c918496818b49d593d7ea375a5

This snippet demonstrates how to make a POST request to the BambooHR API to retrieve field options. It includes the necessary URL, headers, and content type.

```shell
curl --request POST \
     --url https://example.bamboohr.com/api/v1/datasets/datasetName/field-options \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

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

### Get Goals Filters - Sample Request URL

Source: https://documentation.bamboohr.com/reference/get-goals-filters-v1-1

Provides a sample URL for the 'Get Goals Filters' API endpoint, illustrating the structure with a placeholder employee ID.

```Text
https://api.bamboohr.com/api/gateway.php/samplecompany/v1/performance/employees/123/goals/filters
```

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

### Get Tabular Fields (cURL)

Source: https://documentation.bamboohr.com/reference/metadata-get-a-list-of-tabular-fields-2

Example cURL request to retrieve a list of all tabular fields available in a BambooHR account. Specifies the GET method, the API endpoint, and the desired Accept header for JSON output.

```Shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/meta/tables \
     --header 'accept: application/json'
```

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

### Get Statuses - Python

Source: https://documentation.bamboohr.com/reference/get-statuses-1

Provides a Python example for retrieving company statuses. This commonly uses the 'requests' library to handle the HTTP GET request and authentication.

```python
import requests

def get_statuses(company_domain, access_token):
    url = f"https://{company_domain}.bamboohr.com/api/v1/applicant_tracking/statuses"
    headers = {
        'accept': 'application/json',
        'Authorization': f'Bearer {access_token}'
    }
    
    try:
        response = requests.get(url, headers=headers)
        response.raise_for_status()  # Raise an exception for bad status codes (4xx or 5xx)
        return response.json()
    except requests.exceptions.RequestException as e:
        print(f"Error fetching statuses: {e}")
        return None

```

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

### cURL Request to Get Fields (JSON)

Source: https://documentation.bamboohr.com/reference/metadata-get-a-list-of-fields

Example of how to make a GET request using cURL to the BambooHR API to retrieve a list of fields in JSON format. Requires specifying the company domain and the accept header.

```shell
curl --request GET \
     --url https://api.bamboohr.com/api/gateway.php/companyDomain/v1/meta/fields/ \
     --header 'accept: application/json'
```

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

### Get Company Report (JSON Example)

Source: https://documentation.bamboohr.com/reference/get-company-report

This JSON snippet demonstrates the structure of a company report response from the BambooHR API. It includes report details, a list of fields with their properties, and employee data.

```json
{
    "title": "This is my report",
    "fields": [
        {
            "id": "firstName",
            "type": "text",
            "name": "First Name"
        },
        {
            "id": "lastName",
            "type": "text",
            "name": "Last Name"
        },
        {
            "id": "91",
            "type": "employee",
            "name": "Supervisor"
        }
    ],
    "employees": [
        {
            "firstName":"John",
            "lastName":"Doe",
            "91": "Jane Doe"
        }
    ]
}
```

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

### Example Timesheet Entries Response (JSON)

Source: https://documentation.bamboohr.com/reference/134f6593587d7195536c151bd65eb6d5

Provides an example JSON response structure for a successful retrieval of timesheet entries. This includes details like entry ID, employee ID, dates, hours, and approval status.

```json
[
  {
    "id": 7,
    "employeeId": 40344,
    "type": "clock",
    "date": "2023-01-01",
    "start": "2023-01-01T16:00:00+00:00",
    "end": "2023-01-02T00:00:00+00:00",
    "timezone": "America/Vancouver",
    "hours": 8,
    "note": "Note details appear here.",
    "projectInfo": {
    	"project": {
      	"id": 1,
        "name": "Project 1"
      },
      "task": {
      	"id": 1,
        "name": "Task 1"
      }
    },
    "approvedAt": "2023-01-14T12:00:00+00:00",
    "approved": true
  },
  {
    "id": 34,
    "employeeId": 40341,
    "type": "hour",
    "date": "2023-01-13",
    "start": null,
    "end": null,
    "timezone": null,
    "hours": 8,
    "note": null,
    "projectInfo": null,
    "approvedAt": null,
    "approved": false
  }
]
```

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

### Get All Aggregate Goal Info - Sample Request URL

Source: https://documentation.bamboohr.com/reference/get-goals-aggregate-v1-1

This is a sample URL for the Get All Aggregate Goal Info endpoint in the BambooHR API. It demonstrates how to structure the request with a company domain and employee ID.

```text
https://api.bamboohr.com/api/gateway.php/samplecompany/v1/performance/employees/123/goals/aggregate
```

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

### Get Goals cURL Request

Source: https://documentation.bamboohr.com/reference/get-goals-1

Demonstrates how to make a GET request to the Get Goals API endpoint using cURL, including necessary headers for JSON acceptance.

```shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/performance/employees/employeeId/goals \
     --header 'accept: application/json'
```

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

### Get Goals API Sample Response

Source: https://documentation.bamboohr.com/reference/get-goals-1

Illustrates the JSON structure of a successful response from the Get Goals API, detailing employee goals with properties like ID, title, description, and completion status.

```json
{
    "goals": [
        {
            "id": "5",
            "title": "scelerisque Sollicitudin elementum dignissim adipiscing aliquet ",
            "description": "etiam sit consequat enim adipiscing egestas ut curabitur mi nulla at congue at enim amet tincidunt Feugiat tortor Est vestibulum At sit In velit sit enim Eleifend viverra at. vulputate neque Feugiat morbi eget. Egestas eget ",
            "percentComplete": 100,
            "alignsWithOptionId": "",
            "sharedWithEmployeeIds": [
                1234
            ],
            "dueDate": "2021-01-22",
            "completionDate": "2021-06-30T00:00:00Z"
        },
        {
            "id": "16",
            "title": "Lorem ipsum dolor sit amet",
            "description": "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
            "percentComplete": 0,
            "alignsWithOptionId": null,
            "sharedWithEmployeeIds": [
                1234
            ],
            "dueDate": "2024-03-17",
            "completionDate": null,
            "status": "in_progress",
            "milestones": [
                {
                    "id": 17,
                    "employeeGoalId": 16,
                    "title": "Duis aute irure dolor",
                    "currentValue": 100,
                    "startValue": 100,
                    "endValue": 50,
                    "completedDateTime": null,
                    "lastUpdateDateTime": "2022-07-15T15:37:02Z",
                    "lastUpdateUserId": 1234
                }
            ],
            "actions": {
                "canEditGoalProgressBar": false,
                "canEditGoalMilestoneProgressBar": true
            }
        }
    ]
}
```

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

### Get Employee Directory - XML Response Example

Source: https://documentation.bamboohr.com/reference/get-employees-directory

This XML snippet illustrates the format of the employee directory data when requested with an `application/xml` Accept header. It mirrors the JSON structure, using elements like `<field>` and `<employee>` to represent the directory information.

```xml
<directory>
    <fieldset>
        <field id="displayName">Display name</field>
        <field id="firstName">First name</field>
        <field id="lastName">Last name</field>
        <field id="gender">Gender</field>
        <field id="jobTitle">Job title</field>
        <field id="workPhone">Work Phone</field>
        <field id="workPhoneExtension">Work Extension</field>
        <field id="skypeUsername">Skype Username</field>
        <field id="facebook">Facebook URL</field>
    </fieldset>
    <employees>
        <employee id="123">
            <field id="displayName">John Doe</field>
            <field id="firstName">John</field>
            <field id="lastName">Doe</field>
            <field id="gender">Male</field>
            <field id="jobTitle">Customer Service Representative</field>
            <field id="workPhone">555-555-5555</field>
            <field id="workPhoneExtension"/>
            <field id="skypeUsername">JohnDoe</field>
            <field id="facebook">JohnDoeFacebook</field>
        </employee>
    </employees>
</directory>
```

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

### Get Goals Filters - Sample Response

Source: https://documentation.bamboohr.com/reference/get-goals-filters-v1-1

Shows a sample JSON response from the 'Get Goals Filters' endpoint, detailing the number of goals for each status (e.g., 'In Progress', 'Completed').

```JSON
{
    "filters": [
        {
            "id": "status-inProgress",
            "name": "In Progress",
            "count": 4
        },
        {
            "id": "status-completed",
            "name": "Completed",
            "count": 2
        }
    ]
}
```

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

### cURL Request to Get Employee Table Rows

Source: https://documentation.bamboohr.com/reference/get-employee-table-row

Demonstrates how to make a GET request using cURL to retrieve employee table data. This example specifies the Accept header to request an XML response. It includes placeholders for the company domain, employee ID, and table name.

```shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/employees/id/tables/table \
     --header 'accept: application/xml'

```

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

### Get Data Sets - cURL Request

Source: https://documentation.bamboohr.com/reference/getdatasets-1

This cURL command demonstrates how to make a GET request to the BambooHR API to retrieve available datasets. It includes the necessary URL and an 'accept' header for JSON format.

```Shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/datasets \
     --header 'accept: application/json'
```

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

### Get All Aggregate Goal Info - Sample Response

Source: https://documentation.bamboohr.com/reference/get-goals-aggregate-v1-1

This JSON object represents a sample response from the Get All Aggregate Goal Info endpoint. It includes goal status filters, a list of goals with details like title, description, completion percentage, and shared employees, as well as information about associated persons and comment counts.

```json
{
    "canAlign": false,
    "canCreateGoals": true,
    "filters": [
        {
            "id": "status-inProgress",
            "name": "In Progress",
            "count": 2
        },
        {
            "id": "status-completed",
            "name": "Completed",
            "count": 1
        }
    ],
    "selectedFilter": "status-inProgress",
    "goals": [
        {
            "id": "1",
            "title": "Lorem ipsum dolor sit amet",
            "description": "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat",
            "percentComplete": 60,
            "alignsWithOptionId": null,
            "sharedWithEmployeeIds": [
                23
            ],
            "dueDate": "2021-12-17",
            "completionDate": null,
            "status": "in_progress"
        },
        {
            "id": "2",
            "title": "Duis aute irure",
            "description": null,
            "percentComplete": 70,
            "alignsWithOptionId": null,
            "sharedWithEmployeeIds": [
                23,
                24
            ],
            "dueDate": "2022-05-31",
            "completionDate": null,
            "status": "in_progress"
        }
    ],
    "persons": [
        {
            "employeeId": 23,
            "userId": null,
            "displayFirstName": "Poe",
            "lastName": "Panda",
            "photoUrl": "https://poePandaImage.jpg"
        },
        {
            "employeeId": 24,
            "userId": null,
            "displayFirstName": "Jim",
            "lastName": "Panda",
            "photoUrl": "https://jimPandaImage.jpg"
        }
    ],
    "comments": [
        {
            "goalId": "1",
            "commentCount": 1
        },
        {
            "goalId": "2",
            "commentCount": 0
        }
    ]
}
```

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

### cURL Request for Get Aggregate Goal Info

Source: https://documentation.bamboohr.com/reference/get-goal-aggregate-1

This cURL command demonstrates how to make a GET request to the BambooHR API to retrieve aggregate goal information. It includes the necessary URL and headers for authentication.

```shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/performance/employees/employeeId/goals/goalId/aggregate \
     --header 'accept: application/json'
```

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

### Get a list of fields (Shell/cURL)

Source: https://documentation.bamboohr.com/reference/metadata-get-a-list-of-fields-2

This snippet demonstrates how to retrieve a list of all fields available in a BambooHR account using the cURL command. It specifies the GET request method, the endpoint URL, and the desired response format (JSON) via the Accept header.

```Shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/meta/fields \
     --header 'accept: application/json'
```

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

### Get Company Information (cURL)

Source: https://documentation.bamboohr.com/reference/get-company-information-2

Demonstrates how to retrieve company information using a GET request via cURL. It specifies the URL and the expected JSON acceptance header.

```Shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/company_information \
     --header 'accept: application/json'
```

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

### Create Time Tracking Project

Source: https://documentation.bamboohr.com/reference/time-tracking-1

Creates a new project for time tracking.

```APIDOC
## POST /time_tracking_projects

### Description
Creates a new project for time tracking.

### Method
POST

### Endpoint
/time_tracking_projects

### Parameters
#### Request Body
- **name** (string) - Required - The name of the project.
- **description** (string) - Optional - A description of the project.

### Request Example
```json
{
  "name": "New Feature Development",
  "description": "Work on the upcoming feature release."
}
```

### Response
#### Success Response (201)
- **id** (integer) - The ID of the created project.
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "id": 900,
  "message": "Time tracking project created successfully."
}
```
```

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

### Get Timesheet Entries using cURL

Source: https://documentation.bamboohr.com/reference/134f6593587d7195536c151bd65eb6d5

Demonstrates how to retrieve timesheet entries using a cURL request. This example shows the GET request to the specified endpoint with an accept header for JSON.

```shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/time_tracking/timesheet_entries \
     --header 'accept: application/json'
```

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

### Create Time Tracking Project

Source: https://documentation.bamboohr.com/reference/index

Creates a new project for time tracking purposes.

```APIDOC
## POST /time-tracking/projects

### Description
Creates a new time tracking project.

### Method
POST

### Endpoint
/time-tracking/projects

### Parameters
#### Request Body
- **name** (string) - Required - The name of the project.
- **description** (string) - Optional - A description of the project.

### Request Example
```json
{
  "name": "Website Redesign",
  "description": "Project for redesigning the company website."
}
```

### Response
#### Success Response (201)
- **id** (integer) - The ID of the newly created project.
- **name** (string) - The name of the project.

#### Response Example
```json
{
  "id": 789,
  "name": "Website Redesign"
}
```
```

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

### Sample Request URL for Reopening a Goal

Source: https://documentation.bamboohr.com/reference/post-reopen-goal-1

An example of a complete URL used to reopen a specific goal for an employee.

```text
https://api.bamboohr.com/api/gateway.php/samplecompany/v1/performance/employees/123/goals/20/reopen
```

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

### Sample Request URL

Source: https://documentation.bamboohr.com/reference/put-goal-progress-1

An example of the URL used to update a goal's progress, including placeholders for the company domain, employee ID, and goal ID.

```Text
https://api.bamboohr.com/api/gateway.php/samplecompany/v1/performance/employees/123/goals/20/progress
```

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

### Get Goal Comments - cURL Request

Source: https://documentation.bamboohr.com/reference/get-goal-comments-1

Example cURL command to retrieve comments for a specific goal. Requires authentication and specifies the target URL with employee and goal IDs.

```Shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/performance/employees/employeeId/goals/goalId/comments \
     --header 'accept: application/json'
```

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

### cURL Request Example

Source: https://documentation.bamboohr.com/reference/put-goal-progress-1

A cURL command to update goal progress, demonstrating the PUT request, URL, and necessary headers for authentication and content type.

```Shell
curl --request PUT \
     --url https://example.bamboohr.com/api/v1/performance/employees/employeeId/goals/goalId/progress \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

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

### Sample Request URL for Goal Sharing Options

Source: https://documentation.bamboohr.com/reference/get-goals-share-options-1

This is a sample URL for the BambooHR API endpoint to fetch goal sharing options. It includes placeholder values for the company domain and employee ID, along with query parameters for searching and limiting results.

```Text
https://api.bamboohr.com/api/gateway.php/samplecompany/v1/performance/employees/1234/goals/shareOptions?search=d&limit=3
```

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

### Sample Response Body for Reopening a Goal (With Milestones)

Source: https://documentation.bamboohr.com/reference/post-reopen-goal-1

A sample JSON response when a goal is successfully reopened and has associated milestones. It includes goal details and milestone information.

```json
{
    "goal": {
        "id": "20",
        "title": "Complete all pending tasks",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus sed congue velit, ut posuere nisl.",
        "percentComplete": 0,
        "alignsWithOptionId": null,
        "sharedWithEmployeeIds": [
            123
        ],
        "dueDate": "2024-05-04",
        "completionDate": null,
        "status": "in_progress",
        "milestones": [
            {
                "id": 17,
                "employeeGoalId": 16,
                "title": "Lorem ipsum dolor sit amet",
                "currentValue": 100,
                "startValue": 100,
                "endValue": 50,
                "completedDateTime": null,
                "lastUpdateDateTime": "2022-07-15T15:37:02Z",
                "lastUpdateUserId": 123
            }
         ],
         "actions": {
            "canEditGoalProgressBar": false,
            "canEditGoalMilestoneProgressBar": true
        }
    }
}
```

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

### Get Statuses - Node.js

Source: https://documentation.bamboohr.com/reference/get-statuses-1

Example of fetching company statuses using Node.js. This code snippet would typically use a library like 'axios' or the built-in 'https' module to make the GET request to the BambooHR API.

```javascript
/*
  Example for Node.js would go here.
  This would involve using a library like 'axios' or the native 'https' module.
  Example:

  const axios = require('axios');

  async function getStatuses(companyDomain) {
    const url = `https://${companyDomain}.bamboohr.com/api/v1/applicant_tracking/statuses`;
    try {
      const response = await axios.get(url, {
        headers: {
          'accept': 'application/json',
          'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
        }
      });
      return response.data;
    } catch (error) {
      console.error('Error fetching statuses:', error);
      throw error;
    }
  }
*/
```

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

### Add Timesheet Clock-In Entry Example Request (JSON)

Source: https://documentation.bamboohr.com/reference/43c7cc099ca54295a047f449824fc0dd

An example JSON payload for clocking in an employee, including project and task IDs, and an optional note.

```json
{
  "projectId": 10,
  "taskId": 24,
  "note": "Working on project A."
}
```

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

### Add New Job Opening via API

Source: https://documentation.bamboohr.com/reference/add-new-job-opening-1

This snippet demonstrates how to add a new job opening using the BambooHR API. It requires a company domain and an API key with ATS settings access. The request body includes details about the job posting, status, hiring lead, and description.

```HTTP
post https://{companyDomain}.bamboohr.com/api/v1/applicant_tracking/job_opening
```

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

### Sample Request URL for Get Aggregate Goal Info

Source: https://documentation.bamboohr.com/reference/get-goal-aggregate-1

This is a sample URL for fetching aggregate goal information from the BambooHR API. It requires the company domain, employee ID, and goal ID.

```text
https://api.bamboohr.com/api/gateway.php/samplecompany/v1/performance/employees/123/goals/20/aggregate
```

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

### Get Goal Status Counts (Shell)

Source: https://documentation.bamboohr.com/reference/get-goals-filters-v12

Example cURL request to retrieve the number of goals per status for an employee. It specifies the HTTP method, URL with placeholder employee ID, and the expected response format.

```Shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1_2/performance/employees/employeeId/goals/filters \
     --header 'accept: application/json'
```

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

### Sample Response Body for Reopening a Goal (Without Milestones)

Source: https://documentation.bamboohr.com/reference/post-reopen-goal-1

A sample JSON response when a goal is successfully reopened and does not have any milestones. It includes basic goal information.

```json
{
    "goal": {
        "id": "20",
        "title": "Lorem ipsum",
        "description": "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
        "percentComplete": 75,
        "alignsWithOptionId": null,
        "sharedWithEmployeeIds": [
            123
        ],
        "dueDate": "2021-03-17",
        "completionDate": null,
        "status": "completed"
    }
}
```

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

### Get Employee Directory - JSON Response Example

Source: https://documentation.bamboohr.com/reference/get-employees-directory

This JSON snippet demonstrates the structure of a successful response when retrieving the employee directory. It includes fields like 'id', 'type', and 'name' for each employee attribute, along with employee data such as 'displayName', 'firstName', and 'lastName'.

```json
{
    "fields": [
        {
            "id": "displayName",
            "type": "text",
            "name": "Display Name"
        },
        {
            "id": "firstName",
            "type": "text",
            "name": "First Name"
        },
        {
            "id": "lastName",
            "type": "text",
            "name": "Last Name"
        },
        {
            "id": "gender",
            "type": "text",
            "name": "Gender"
        },
        {
            "id": "jobTitle",
            "type": "list",
            "name": "Job Title"
        },
        {
            "id": "workPhone",
            "type": "text",
            "name": "Work Phone"
        },
        {
            "id": "workPhoneExtension",
            "type": "text",
            "name": "Work Extension"
        },
        {
            "id": "skypeUsername",
            "type": "text",
            "name": "Skype Username"
        },
        {
            "id": "facebook",
            "type": "text",
            "name": "Facebook URL"
        }
    ],
    "employees": [
        {
            "id":123,
            "displayName":"John Doe",
            "firstName":"John",
            "lastName":"Doe",
            "gender":"Male",
            "jobTitle":"Customer Service Representative",
            "workPhone":"555-555-5555",
            "workPhoneExtension":null,
            "skypeUsername":"JohnDoe",
            "facebook":"JohnDoeFacebook"
        }
    ]
}
```

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

### Add Timesheet Clock-In Entry Example Response (JSON)

Source: https://documentation.bamboohr.com/reference/43c7cc099ca54295a047f449824fc0dd

An example JSON response upon successfully clocking in an employee, detailing the new timesheet entry information.

```json
{
  "id": 37,
  "employeeId": 11718,
  "type": "clock",
  "date": "2023-06-23",
  "start": "2023-06-23T17:20:00+00:00",
  "end": null,
  "timezone": "America/Halifax",
  "hours": null,
  "note": "Working on project A.",
  "projectInfo": {
    "project": {
      "id": 10,
      "name": "Project A"
    },
    "task": {
      "id": 24,
      "name": "Task 1"
    }
  }
}
```

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

### Get Goals Filters - cURL Request

Source: https://documentation.bamboohr.com/reference/get-goals-filters-v1-1

Demonstrates how to make a GET request to the 'Get Goals Filters' endpoint using cURL. It specifies the URL and the expected JSON 'accept' header.

```Shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/performance/employees/employeeId/goals/filters \
     --header 'accept: application/json'
```

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

### Get Webhook cURL Request

Source: https://documentation.bamboohr.com/reference/get-webhook-1

This snippet demonstrates how to make a GET request to retrieve webhook data using cURL. It includes the necessary URL and headers.

```Shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/webhooks/id \
     --header 'accept: application/json'
```

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

### Sample Response With Milestones

Source: https://documentation.bamboohr.com/reference/get-goal-aggregate-1

This JSON response provides detailed information about a goal, including its title, description, completion status, associated milestones, and a list of persons with access to the goal. It also includes actions that can be performed on the goal.

```json
{
    "goal": {
        "id": "20",
        "title": "Lorem ipsum",
        "description": "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
        "percentComplete": 100,
        "alignsWithOptionId": null,
        "sharedWithEmployeeIds": [
            123
        ],
        "dueDate": "2021-03-17",
        "completionDate": "2022-05-26T20:07:45Z",
        "status": "completed",
        "milestones": [
            {
                "id": 17,
                "employeeGoalId": 16,
                "title": "Lorem ipsum dolor sit amet",
                "currentValue": 100,
                "startValue": 100,
                "endValue": 50,
                "completedDateTime": null,
                "lastUpdateDateTime": "2022-07-15T15:37:02Z",
                "lastUpdateUserId": 123
            }
         ],
         "actions": {
            "canEditGoalProgressBar": false,
            "canEditGoalMilestoneProgressBar": true
        }
    },
    "canAlign": false,
    "canCreateGoals": true,
    "alignsWithOptions": [],
    "comments": [],
    "persons": [
        {
            "employeeId": 123,
            "userId": null,
            "displayFirstName": "Poe",
            "lastName": "Panda",
            "photoUrl": "https://poePandaImage.json"
        }
    ]
}
```

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

### Create Goal Comment - cURL Example

Source: https://documentation.bamboohr.com/reference/post-goal-comment-1

This snippet demonstrates how to create a goal comment using a cURL request. It specifies the POST method, the API endpoint with placeholders for company domain, employee ID, and goal ID, and includes headers for content type and acceptance of JSON.

```Shell
curl --request POST \
     --url https://example.bamboohr.com/api/v1/performance/employees/employeeId/goals/goalId/comments \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

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

### Update Goal - Sample URL

Source: https://documentation.bamboohr.com/reference/put-goal-v11-1

Provides an example of the API endpoint URL for updating a goal, including placeholders for company domain, employee ID, and goal ID.

```text
https://api.bamboohr.com/api/gateway.php/samplecompany/v1_1/performance/employees/123/goals/10
```

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

### Get Employee File using cURL

Source: https://documentation.bamboohr.com/reference/get-employee-file

This snippet demonstrates how to retrieve an employee file using a cURL GET request. It includes the necessary URL and headers.

```Shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/employees/0/files/fileId \
     --header 'accept: application/json'
```

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

### Close Goal - Sample Request URL

Source: https://documentation.bamboohr.com/reference/post-close-goal-1

Example URL for closing a specific employee's goal.

```text
https://api.bamboohr.com/api/gateway.php/samplecompany/v1/performance/employees/123/goals/20/close
```

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

### Get Goals Filters cURL Request

Source: https://documentation.bamboohr.com/reference/get-goals-filters-v11-1

This cURL command demonstrates how to make a GET request to the BambooHR API to retrieve goal filters for an employee. It includes the URL and the expected 'accept' header.

```curl
curl --request GET \
     --url https://example.bamboohr.com/api/v1_1/performance/employees/employeeId/goals/filters \
     --header 'accept: application/json'
```

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

### Get Time Off Requests API Request (cURL)

Source: https://documentation.bamboohr.com/reference/time-off-get-time-off-requests-2

Demonstrates how to make a GET request to the BambooHR API to retrieve time off requests using cURL. It specifies the URL and the 'Accept' header for JSON response.

```Shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/time_off/requests \
     --header 'accept: application/json'
```

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

### Get Goals Filters Sample Request URL (Text)

Source: https://documentation.bamboohr.com/reference/get-goals-filters-v11-1

This is a sample URL to retrieve goal filters for an employee. It specifies the base URL, API version, and the employee ID.

```text
https://api.bamboohr.com/api/gateway.php/samplecompany/v1_1/performance/employees/123/goals/filters
```

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

### Get Company Report - cURL Request

Source: https://documentation.bamboohr.com/reference/get-company-report

This cURL command shows how to make a GET request to the BambooHR API to retrieve a company report. It specifies the report ID and accepts the response in JSON format.

```shell
curl --request GET \
     --url 'https://example.bamboohr.com/api/v1/reports/id?onlyCurrent=1' \
     --header 'accept: application/json'
```

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

### Add Employee cURL Request

Source: https://documentation.bamboohr.com/reference/add-employee

This example demonstrates how to add an employee using a cURL request. It specifies the POST method, the API endpoint URL, and the necessary 'accept' and 'content-type' headers.

```shell
curl --request POST \
     --url https://example.bamboohr.com/api/v1/employees \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

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

### Get Company Locations (Shell/cURL)

Source: https://documentation.bamboohr.com/reference/get-company-locations-1

Demonstrates how to retrieve company locations using a cURL command. This requires specifying the HTTP method (GET), the API endpoint URL, and the 'accept' header for JSON response.

```shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/applicant_tracking/locations \
     --header 'accept: application/json'
```

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

### Get List Fields Details (cURL)

Source: https://documentation.bamboohr.com/reference/metadata-get-details-for-list-fields-2

Demonstrates how to retrieve details for all list fields using cURL. It specifies the GET request method, the API endpoint, and the desired 'Accept' header for JSON response.

```Shell
curl --request GET \
     --url https://example.bamboohr.com/api/v1/meta/lists \
     --header 'accept: application/json'
```