> For the complete documentation index, see [llms.txt](https://knowledge.out-smart.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledge.out-smart.com/openapi/employees.md).

# Employees

## Get employees

> This endpoint is used to get employee data from OutSmart.  \
> Each employee record can contain the following data:\
> \
> \| Parameter | Description |\
> \| --- | --- |\
> \| firstname | First name of the employee |\
> \| lastname | Last name of the Employee |\
> \| number | Unique number used as id for this employee |\
> \| active | Bit value indicating whether the employee is set as active. Active employees use a license of the OutSmart account. Possible values:  \<br>0 - indicates inactive user  \<br>1 - indicates active user |\
> \| mobile | Mobile phone number of the employee |\
> \| email | Email address of the employee |\
> \| address | Employee home address: street address and house number |\
> \| zipcode | Postal code of the employee's home address |\
> \| city | Employee's home address city |\
> \| country | Employee's country residence |\
> \| latitude | Latitude coordinate. Used for displaying the employee's location on the map next to the planning board. Commonly used with GPS track & trace integrations |\
> \| longitude | Longitude coordinate. Used for displaying the employee's location on the map next to the planning board. Commonly used with GPS track & trace integrations |\
> \| warehouse |  |\
> \| vehicle | ID of the vehicle driven by the employee. Mainly used with GPS track & trace integrations |\
> \| birthday | Birthday of the employee |\
> \| emp\_freefield\_1 | Freefield. Can be used for storing any additional data |\
> \| emp\_freefield\_2 | Freefield. Can be used for storing any additional data |\
> \| emp\_freefield\_3 | Freefield. Can be used for storing any additional data |\
> \| emp\_freefield\_4 | Freefield. Can be used for storing any additional data |\
> \| emp\_freefield\_5 | Freefield. Can be used for storing any additional data |\
> \| emp\_certification\_number\_1 |  |\
> \| emp\_certification\_number\_2 |  |\
> \| emp\_order | Integer value. Determines the order in which employees are displayed on the planbord |\
> \| start\_type | Defines the type of the employee's starting location. Mainly used for GPS track and trace integrations, to determine the start of a work day.  \<br>  \<br>Possible values:  \<br>EMPLOYEE\_ADDRESS - Starting address is equal to the employee's home address  \<br>  \<br>COMPANY\_ADDRESS - Starting address is equal to the company address details set in the Outsmart account  \<br>  \<br>OTHER - Option to supply a different starting address manually. Use starting address fields as additional input |\
> \| start\_address | Starting address for employee. Street name and house number |\
> \| start\_city | Starting address city for the employee |\
> \| start\_zipcode | Starting address postal code for the employee |\
> \| start\_country | Starting address country for the employee |\
> \| start\_latitude | Starting address latitude coordinates |\
> \| start\_longitude | Starting address longitude coordinates |

```json
{"openapi":"3.1.0","info":{"title":"OpenApi","version":"1.0.0"},"servers":[{"url":"{{api_url}}"},{"url":"https://www.werkbonapp.nl"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/employees/":{"get":{"summary":"Get employees","parameters":[{"name":"token","in":"query","schema":{"type":"string"}},{"name":"software_token","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Response_200"}},"tags":["Employees"],"description":"This endpoint is used to get employee data from OutSmart.  \nEach employee record can contain the following data:\n\n| Parameter | Description |\n| --- | --- |\n| firstname | First name of the employee |\n| lastname | Last name of the Employee |\n| number | Unique number used as id for this employee |\n| active | Bit value indicating whether the employee is set as active. Active employees use a license of the OutSmart account. Possible values:  <br>0 - indicates inactive user  <br>1 - indicates active user |\n| mobile | Mobile phone number of the employee |\n| email | Email address of the employee |\n| address | Employee home address: street address and house number |\n| zipcode | Postal code of the employee's home address |\n| city | Employee's home address city |\n| country | Employee's country residence |\n| latitude | Latitude coordinate. Used for displaying the employee's location on the map next to the planning board. Commonly used with GPS track & trace integrations |\n| longitude | Longitude coordinate. Used for displaying the employee's location on the map next to the planning board. Commonly used with GPS track & trace integrations |\n| warehouse |  |\n| vehicle | ID of the vehicle driven by the employee. Mainly used with GPS track & trace integrations |\n| birthday | Birthday of the employee |\n| emp_freefield_1 | Freefield. Can be used for storing any additional data |\n| emp_freefield_2 | Freefield. Can be used for storing any additional data |\n| emp_freefield_3 | Freefield. Can be used for storing any additional data |\n| emp_freefield_4 | Freefield. Can be used for storing any additional data |\n| emp_freefield_5 | Freefield. Can be used for storing any additional data |\n| emp_certification_number_1 |  |\n| emp_certification_number_2 |  |\n| emp_order | Integer value. Determines the order in which employees are displayed on the planbord |\n| start_type | Defines the type of the employee's starting location. Mainly used for GPS track and trace integrations, to determine the start of a work day.  <br>  <br>Possible values:  <br>EMPLOYEE_ADDRESS - Starting address is equal to the employee's home address  <br>  <br>COMPANY_ADDRESS - Starting address is equal to the company address details set in the Outsmart account  <br>  <br>OTHER - Option to supply a different starting address manually. Use starting address fields as additional input |\n| start_address | Starting address for employee. Street name and house number |\n| start_city | Starting address city for the employee |\n| start_zipcode | Starting address postal code for the employee |\n| start_country | Starting address country for the employee |\n| start_latitude | Starting address latitude coordinates |\n| start_longitude | Starting address longitude coordinates |"}}}}
```

## Add employees

> Use this endpoint to create or edit employee data in OutSmart. When an employee with the supplied number exists, the existing employee record will be overwritten.  \
> Each employee record can contain the following data:\
> \
> \| Parameter | Required | Description |\
> \| --- | --- | --- |\
> \| number | Y | Unique number used as id for this employee |\
> \| firstname | Y | First name of the employee |\
> \| lastname | Y | Last name of the Employee |\
> \| active | N | Bit value indicating whether the employee is set as active. Active employees use a license of the OutSmart account. Possible values:  \<br>0 - indicates inactive user  \<br>1 - indicates active user |\
> \| mobile | N | Mobile phone number of the employee |\
> \| email | N | Email address of the employee |\
> \| address | N | Employee home address: street address and house number |\
> \| zipcode | N | Postal code of the employee's home address |\
> \| city | N | Employee's home address city |\
> \| country | N | Employee's country residence |\
> \| latitude | N | Latitude coordinate. Used for displaying the employee's location on the map next to the planning board. Commonly used with GPS track & trace integrations |\
> \| longitude | N | Longitude coordinate. Used for displaying the employee's location on the map next to the planning board. Commonly used with GPS track & trace integrations |\
> \| warehouse | N |  |\
> \| vehicle | N | ID of the vehicle driven by the employee. Mainly used with GPS track & trace integrations |\
> \| birthday | N | Birthday of the employee |\
> \| emp\_freefield\_1 | N | Freefield. Can be used for storing any additional data |\
> \| emp\_freefield\_2 | N | Freefield. Can be used for storing any additional data |\
> \| emp\_freefield\_3 | N | Freefield. Can be used for storing any additional data |\
> \| emp\_freefield\_4 | N | Freefield. Can be used for storing any additional data |\
> \| emp\_freefield\_5 | N | Freefield. Can be used for storing any additional data |\
> \| emp\_certification\_number\_1 | N |  |\
> \| emp\_certification\_number\_2 | N |  |\
> \| emp\_order | N | Integer value. Determines the order in which employees are displayed on the planbord |\
> \| start\_type | N | Defines the type of the employee's starting location. Mainly used for GPS track and trace integrations, to determine the start of a work day.  \<br>  \<br>Possible values:  \<br>EMPLOYEE\_ADDRESS - Starting address is equal to the employee's home address  \<br>  \<br>COMPANY\_ADDRESS - Starting address is equal to the company address details set in the Outsmart account  \<br>  \<br>OTHER - Option to supply a different starting address manually. Use starting address fields as additional input |\
> \| start\_address | N | Starting address for employee. Street name and house number |\
> \| start\_city | N | Starting address city for the employee |\
> \| start\_zipcode | N | Starting address postal code for the employee |\
> \| start\_country | N | Starting address country for the employee |\
> \| start\_latitude | N | Starting address latitude coordinates |\
> \| start\_longitude | N | Starting address longitude coordinates |

```json
{"openapi":"3.1.0","info":{"title":"OpenApi","version":"1.0.0"},"servers":[{"url":"{{api_url}}"},{"url":"https://www.werkbonapp.nl"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/employees/":{"post":{"summary":"Add employees","parameters":[{"name":"token","in":"query","schema":{"type":"string"}},{"name":"software_token","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Response_200","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer"},"messages":{"type":"array"},"response":{"type":"integer"}}}}}}},"tags":["Employees"],"description":"Use this endpoint to create or edit employee data in OutSmart. When an employee with the supplied number exists, the existing employee record will be overwritten.  \nEach employee record can contain the following data:\n\n| Parameter | Required | Description |\n| --- | --- | --- |\n| number | Y | Unique number used as id for this employee |\n| firstname | Y | First name of the employee |\n| lastname | Y | Last name of the Employee |\n| active | N | Bit value indicating whether the employee is set as active. Active employees use a license of the OutSmart account. Possible values:  <br>0 - indicates inactive user  <br>1 - indicates active user |\n| mobile | N | Mobile phone number of the employee |\n| email | N | Email address of the employee |\n| address | N | Employee home address: street address and house number |\n| zipcode | N | Postal code of the employee's home address |\n| city | N | Employee's home address city |\n| country | N | Employee's country residence |\n| latitude | N | Latitude coordinate. Used for displaying the employee's location on the map next to the planning board. Commonly used with GPS track & trace integrations |\n| longitude | N | Longitude coordinate. Used for displaying the employee's location on the map next to the planning board. Commonly used with GPS track & trace integrations |\n| warehouse | N |  |\n| vehicle | N | ID of the vehicle driven by the employee. Mainly used with GPS track & trace integrations |\n| birthday | N | Birthday of the employee |\n| emp_freefield_1 | N | Freefield. Can be used for storing any additional data |\n| emp_freefield_2 | N | Freefield. Can be used for storing any additional data |\n| emp_freefield_3 | N | Freefield. Can be used for storing any additional data |\n| emp_freefield_4 | N | Freefield. Can be used for storing any additional data |\n| emp_freefield_5 | N | Freefield. Can be used for storing any additional data |\n| emp_certification_number_1 | N |  |\n| emp_certification_number_2 | N |  |\n| emp_order | N | Integer value. Determines the order in which employees are displayed on the planbord |\n| start_type | N | Defines the type of the employee's starting location. Mainly used for GPS track and trace integrations, to determine the start of a work day.  <br>  <br>Possible values:  <br>EMPLOYEE_ADDRESS - Starting address is equal to the employee's home address  <br>  <br>COMPANY_ADDRESS - Starting address is equal to the company address details set in the Outsmart account  <br>  <br>OTHER - Option to supply a different starting address manually. Use starting address fields as additional input |\n| start_address | N | Starting address for employee. Street name and house number |\n| start_city | N | Starting address city for the employee |\n| start_zipcode | N | Starting address postal code for the employee |\n| start_country | N | Starting address country for the employee |\n| start_latitude | N | Starting address latitude coordinates |\n| start_longitude | N | Starting address longitude coordinates |"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://knowledge.out-smart.com/openapi/employees.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.