> For the complete documentation index, see [llms.txt](https://developer.usemultiplier.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.usemultiplier.com/api-reference/employee-management/list-employees.md).
# List Employees
Search and list employees
## Search and list employees
> Retrieve a paginated list of employees based on various filter criteria.\
> \
> Employees are automatically filtered by the company associated with your authentication token.\
> \
> This endpoint allows you to:\
> \- Filter employees by status\
> \- Sort results by various fields\
> \- Paginate through large result sets\
> \
> \*\*Filter Precedence:\*\*\
> When both \`employeeId\` and \`employeeCode\` are provided, \`employeeId\` takes precedence.\
> It is recommended to use only one filter at a time for clarity.
```json
{"openapi":"3.0.1","info":{"title":"Multiplier Public REST API","version":"1.0.0"},"tags":[{"name":"List Employees","description":"Search and list employees"}],"servers":[{"url":"https://api.usemultiplier.com","description":"Production API / Partner Sandbox"},{"url":"https://release-api-gateway.api.usemultiplier.com","description":"MPL internal release environment"},{"url":"https://api-gateway.api.acc.staging.usemultiplier.com","description":"MPL internal staging"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","description":"JWT Bearer token authentication.\n\nTo authenticate:\n1. Obtain a JWT token from your authentication endpoint\n2. Click the \"Authorize\" button above\n3. Enter your token in the format: your-jwt-token\n4. Click \"Authorize\" to apply to all requests\n\nThe token will be automatically included in the Authorization header\nas: Authorization: Bearer {token}\n","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EmployeeStatus":{"type":"string","description":"Employment status filter","enum":["ONBOARDING","ACTIVE","OFFBOARDING","ENDED","DELETED","ALL"]},"SortByField":{"type":"string","description":"Field to sort by","enum":["startOn"]},"SortOrder":{"type":"string","description":"Sort direction","enum":["ASC","DESC"]},"V1EmployeesGetResponse":{"required":["data","pagination"],"type":"object","properties":{"data":{"type":"array","description":"List of employees matching the search criteria","items":{"$ref":"#/components/schemas/EmployeeData"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"EmployeeData":{"required":["country","customerId","customerName","designation","displayName","firstName","fullName","id","lastName","startDate","status","type"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the employee","format":"uuid"},"employeeCode":{"type":"string","description":"Human-readable employee code (optional)","nullable":true},"employeeId":{"type":"string","description":"Deprecated: Use employeeCode instead. Human-readable employee code (optional)","nullable":true,"deprecated":true},"firstName":{"type":"string","description":"Employee's first name"},"middleName":{"type":"string","description":"Employee's middle name","nullable":true},"lastName":{"type":"string","description":"Employee's last name"},"fullName":{"type":"string","description":"Employee's full legal name"},"displayName":{"type":"string","description":"Display name for the employee"},"workEmail":{"type":"string","description":"Employee's work email address","format":"email","nullable":true},"designation":{"type":"string","description":"Job title/position"},"department":{"type":"string","description":"Department name","nullable":true},"status":{"type":"string","description":"Current employment status","enum":["ONBOARDING","ACTIVE","OFFBOARDING","ENDED","DELETED","UNKNOWN"]},"type":{"type":"string","description":"Type of employment","enum":["EMPLOYEE","CONTRACTOR","FREELANCER","HR_MEMBER","UNKNOWN"]},"startDate":{"type":"string","description":"Employment start date (ISO 8601 format YYYY-MM-DD)","format":"date"},"endDate":{"type":"string","description":"Employment end date (ISO 8601 format YYYY-MM-DD)","format":"date","nullable":true},"country":{"pattern":"^[A-Z]{3}$","type":"string","description":"ISO 3166-1 alpha-3 country code for work location"},"customerId":{"type":"string","description":"ID of the company this employee belongs to","format":"uuid"},"customerName":{"type":"string","description":"Name of the company"},"entity":{"type":"string","description":"Legal entity name for the employee's employment","nullable":true}}},"Pagination":{"required":["page","pageSize","totalCount","totalPages"],"type":"object","properties":{"page":{"type":"integer","description":"Current page number (1-based)"},"pageSize":{"type":"integer","description":"Number of items per page"},"totalCount":{"type":"integer","description":"Total number of items across all pages"},"totalPages":{"type":"integer","description":"Total number of pages"}},"description":"Pagination information for list responses"},"ErrorResponse":{"required":["code","correlationId","message","path","timestamp"],"type":"object","properties":{"timestamp":{"type":"string","description":"ISO-8601 UTC timestamp of when the error occurred","format":"date-time"},"code":{"type":"string","description":"Machine-readable error category","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","VALIDATION_ERROR","SERVICE_UNAVAILABLE","INTERNAL_SERVER_ERROR"]},"message":{"type":"string","description":"Human-readable description of the error"},"path":{"type":"string","description":"Request URI that produced the error"},"correlationId":{"type":"string","description":"Trace ID for correlating this error in logs"},"errors":{"type":"array","description":"Field-level error details. Present for validation errors; may be present for other errors.","items":{"$ref":"#/components/schemas/ErrorItem"}},"error":{"description":"Deprecated: Use errors instead. Backward-compatible error object.","nullable":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/LegacyError"}]}}},"ErrorItem":{"required":["message"],"type":"object","properties":{"property":{"type":"string","description":"The field that caused the error (only present for validation errors)"},"message":{"type":"string","description":"Description of the error"}}},"LegacyError":{"required":["code","message"],"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable error message"},"details":{"type":"array","description":"Field-level error details. Only present for validation errors.","nullable":true,"items":{"$ref":"#/components/schemas/LegacyFieldError"}}},"deprecated":true},"LegacyFieldError":{"required":["field","message"],"type":"object","properties":{"field":{"type":"string","description":"The field that caused the error"},"message":{"type":"string","description":"Description of the field error"}},"deprecated":true}}},"paths":{"/v1/employees":{"get":{"tags":["List Employees"],"summary":"Search and list employees","description":"Retrieve a paginated list of employees based on various filter criteria.\n\nEmployees are automatically filtered by the company associated with your authentication token.\n\nThis endpoint allows you to:\n- Filter employees by status\n- Sort results by various fields\n- Paginate through large result sets\n\n**Filter Precedence:**\nWhen both `employeeId` and `employeeCode` are provided, `employeeId` takes precedence.\nIt is recommended to use only one filter at a time for clarity.\n","operationId":"searchEmployees","parameters":[{"name":"page","in":"query","description":"Page number (1-indexed)","required":false,"style":"form","explode":true,"schema":{"minimum":1,"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":false,"style":"form","explode":true,"schema":{"maximum":100,"minimum":1,"type":"integer","default":20}},{"name":"status","in":"query","description":"Filter by employment status","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/EmployeeStatus"}},{"name":"employeeId","in":"query","description":"Filter by employee ID (UUID, exact match)","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeCode","in":"query","description":"Filter by human-readable employee code (exact match)","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"sortBy","in":"query","description":"Field to sort by. Currently only supports \"startOn\".","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/SortByField"}},{"name":"sortOrder","in":"query","description":"Sort direction","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/SortOrder"}}],"responses":{"200":{"description":"Successfully retrieved employee list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1EmployeesGetResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable entity - validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable - upstream dependency error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
## Get onboarding tracker
> Returns the current onboarding stage for each employee currently in the onboarding lifecycle.\
> \
> Optional filters narrow the result to a specific employee. When both filters are provided\
> they are applied as an AND (intersection).
```json
{"openapi":"3.0.1","info":{"title":"Multiplier Public REST API","version":"1.0.0"},"tags":[{"name":"List Employees","description":"Search and list employees"}],"servers":[{"url":"https://api.usemultiplier.com","description":"Production API / Partner Sandbox"},{"url":"https://release-api-gateway.api.usemultiplier.com","description":"MPL internal release environment"},{"url":"https://api-gateway.api.acc.staging.usemultiplier.com","description":"MPL internal staging"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","description":"JWT Bearer token authentication.\n\nTo authenticate:\n1. Obtain a JWT token from your authentication endpoint\n2. Click the \"Authorize\" button above\n3. Enter your token in the format: your-jwt-token\n4. Click \"Authorize\" to apply to all requests\n\nThe token will be automatically included in the Authorization header\nas: Authorization: Bearer {token}\n","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OnboardingTrackerItem":{"required":["id","stage"],"type":"object","properties":{"id":{"type":"string","description":"Contract public ID (UUID)","format":"uuid"},"employeeCode":{"type":"string","description":"Human-readable employee code","nullable":true},"stage":{"$ref":"#/components/schemas/OnboardingTrackerStage"}}},"OnboardingTrackerStage":{"type":"string","description":"- DRAFT: Contract is being drafted / defined\n- CONTRACT_SENT: Contract sent for signature\n- CONTRACT_SIGNED: All parties have signed\n- EMPLOYEE_INVITED: Employee invited to the platform\n- EMPLOYEE_DETAILS_IN_PROGRESS: Employee filling in their details\n- VERIFICATION: KYC / identity verification in progress\n- PAYROLL_SETUP: Payroll being configured\n","enum":["DRAFT","CONTRACT_SENT","CONTRACT_SIGNED","EMPLOYEE_INVITED","EMPLOYEE_DETAILS_IN_PROGRESS","VERIFICATION","PAYROLL_SETUP"]},"ErrorResponse":{"required":["code","correlationId","message","path","timestamp"],"type":"object","properties":{"timestamp":{"type":"string","description":"ISO-8601 UTC timestamp of when the error occurred","format":"date-time"},"code":{"type":"string","description":"Machine-readable error category","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","VALIDATION_ERROR","SERVICE_UNAVAILABLE","INTERNAL_SERVER_ERROR"]},"message":{"type":"string","description":"Human-readable description of the error"},"path":{"type":"string","description":"Request URI that produced the error"},"correlationId":{"type":"string","description":"Trace ID for correlating this error in logs"},"errors":{"type":"array","description":"Field-level error details. Present for validation errors; may be present for other errors.","items":{"$ref":"#/components/schemas/ErrorItem"}},"error":{"description":"Deprecated: Use errors instead. Backward-compatible error object.","nullable":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/LegacyError"}]}}},"ErrorItem":{"required":["message"],"type":"object","properties":{"property":{"type":"string","description":"The field that caused the error (only present for validation errors)"},"message":{"type":"string","description":"Description of the error"}}},"LegacyError":{"required":["code","message"],"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable error message"},"details":{"type":"array","description":"Field-level error details. Only present for validation errors.","nullable":true,"items":{"$ref":"#/components/schemas/LegacyFieldError"}}},"deprecated":true},"LegacyFieldError":{"required":["field","message"],"type":"object","properties":{"field":{"type":"string","description":"The field that caused the error"},"message":{"type":"string","description":"Description of the field error"}},"deprecated":true}}},"paths":{"/v1/employees/onboarding-tracker":{"get":{"tags":["List Employees"],"summary":"Get onboarding tracker","description":"Returns the current onboarding stage for each employee currently in the onboarding lifecycle.\n\nOptional filters narrow the result to a specific employee. When both filters are provided\nthey are applied as an AND (intersection).\n","operationId":"getOnboardingTracker","parameters":[{"name":"employeeId","in":"query","description":"Filter by employee ID (UUID, exact match)","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeCode","in":"query","description":"Filter by human-readable employee code (exact match)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved onboarding tracker list","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerItem"}}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable - upstream dependency error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
## Get offboarding tracker
> Returns the current offboarding stage for each employee currently in the offboarding lifecycle.\
> \
> Optional filters narrow the result to a specific employee. When both filters are provided\
> they are applied as an AND (intersection).
```json
{"openapi":"3.0.1","info":{"title":"Multiplier Public REST API","version":"1.0.0"},"tags":[{"name":"List Employees","description":"Search and list employees"}],"servers":[{"url":"https://api.usemultiplier.com","description":"Production API / Partner Sandbox"},{"url":"https://release-api-gateway.api.usemultiplier.com","description":"MPL internal release environment"},{"url":"https://api-gateway.api.acc.staging.usemultiplier.com","description":"MPL internal staging"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","description":"JWT Bearer token authentication.\n\nTo authenticate:\n1. Obtain a JWT token from your authentication endpoint\n2. Click the \"Authorize\" button above\n3. Enter your token in the format: your-jwt-token\n4. Click \"Authorize\" to apply to all requests\n\nThe token will be automatically included in the Authorization header\nas: Authorization: Bearer {token}\n","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OffboardingTrackerItem":{"required":["id","stage"],"type":"object","properties":{"id":{"type":"string","description":"Contract public ID (UUID)","format":"uuid"},"employeeCode":{"type":"string","description":"Human-readable employee code","nullable":true},"stage":{"$ref":"#/components/schemas/OffboardingTrackerStage"},"pendingDocuments":{"type":"array","description":"List of pending documents when stage is DOCUMENTS_PENDING","nullable":true,"items":{"$ref":"#/components/schemas/OffboardingPendingDocument"}}}},"OffboardingTrackerStage":{"type":"string","description":"- OFFBOARDING_INITIATED: Offboarding process has started\n- DOCUMENTS_PENDING: Waiting for required documents\n- SETTLEMENT_PENDING: Waiting for final settlement\n- SETTLEMENT_COMPLETE: Final settlement completed\n","enum":["OFFBOARDING_INITIATED","DOCUMENTS_PENDING","SETTLEMENT_PENDING","SETTLEMENT_COMPLETE"]},"OffboardingPendingDocument":{"type":"string","description":"Type of pending document blocking the offboarding process","enum":["SHORTFALL_PAY_DETAILS","WET_INK_LETTER","RESIGNATION_LETTER","GOVT_PORTAL_PROOF"]},"ErrorResponse":{"required":["code","correlationId","message","path","timestamp"],"type":"object","properties":{"timestamp":{"type":"string","description":"ISO-8601 UTC timestamp of when the error occurred","format":"date-time"},"code":{"type":"string","description":"Machine-readable error category","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","VALIDATION_ERROR","SERVICE_UNAVAILABLE","INTERNAL_SERVER_ERROR"]},"message":{"type":"string","description":"Human-readable description of the error"},"path":{"type":"string","description":"Request URI that produced the error"},"correlationId":{"type":"string","description":"Trace ID for correlating this error in logs"},"errors":{"type":"array","description":"Field-level error details. Present for validation errors; may be present for other errors.","items":{"$ref":"#/components/schemas/ErrorItem"}},"error":{"description":"Deprecated: Use errors instead. Backward-compatible error object.","nullable":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/LegacyError"}]}}},"ErrorItem":{"required":["message"],"type":"object","properties":{"property":{"type":"string","description":"The field that caused the error (only present for validation errors)"},"message":{"type":"string","description":"Description of the error"}}},"LegacyError":{"required":["code","message"],"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable error message"},"details":{"type":"array","description":"Field-level error details. Only present for validation errors.","nullable":true,"items":{"$ref":"#/components/schemas/LegacyFieldError"}}},"deprecated":true},"LegacyFieldError":{"required":["field","message"],"type":"object","properties":{"field":{"type":"string","description":"The field that caused the error"},"message":{"type":"string","description":"Description of the field error"}},"deprecated":true}}},"paths":{"/v1/employees/offboarding-tracker":{"get":{"tags":["List Employees"],"summary":"Get offboarding tracker","description":"Returns the current offboarding stage for each employee currently in the offboarding lifecycle.\n\nOptional filters narrow the result to a specific employee. When both filters are provided\nthey are applied as an AND (intersection).\n","operationId":"getOffboardingTracker","parameters":[{"name":"employeeId","in":"query","description":"Filter by employee ID (UUID, exact match)","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"uuid"}},{"name":"employeeCode","in":"query","description":"Filter by human-readable employee code (exact match)","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved offboarding tracker list","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OffboardingTrackerItem"}}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable - upstream dependency error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
## Delete an employee that is still in onboarding
> Deletes an employee by ID that is still in onboarding.
```json
{"openapi":"3.0.1","info":{"title":"Multiplier Public REST API","version":"1.0.0"},"tags":[{"name":"List Employees","description":"Search and list employees"}],"servers":[{"url":"https://api.usemultiplier.com","description":"Production API / Partner Sandbox"},{"url":"https://release-api-gateway.api.usemultiplier.com","description":"MPL internal release environment"},{"url":"https://api-gateway.api.acc.staging.usemultiplier.com","description":"MPL internal staging"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","description":"JWT Bearer token authentication.\n\nTo authenticate:\n1. Obtain a JWT token from your authentication endpoint\n2. Click the \"Authorize\" button above\n3. Enter your token in the format: your-jwt-token\n4. Click \"Authorize\" to apply to all requests\n\nThe token will be automatically included in the Authorization header\nas: Authorization: Bearer {token}\n","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ErrorResponse":{"required":["code","correlationId","message","path","timestamp"],"type":"object","properties":{"timestamp":{"type":"string","description":"ISO-8601 UTC timestamp of when the error occurred","format":"date-time"},"code":{"type":"string","description":"Machine-readable error category","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","VALIDATION_ERROR","SERVICE_UNAVAILABLE","INTERNAL_SERVER_ERROR"]},"message":{"type":"string","description":"Human-readable description of the error"},"path":{"type":"string","description":"Request URI that produced the error"},"correlationId":{"type":"string","description":"Trace ID for correlating this error in logs"},"errors":{"type":"array","description":"Field-level error details. Present for validation errors; may be present for other errors.","items":{"$ref":"#/components/schemas/ErrorItem"}},"error":{"description":"Deprecated: Use errors instead. Backward-compatible error object.","nullable":true,"deprecated":true,"allOf":[{"$ref":"#/components/schemas/LegacyError"}]}}},"ErrorItem":{"required":["message"],"type":"object","properties":{"property":{"type":"string","description":"The field that caused the error (only present for validation errors)"},"message":{"type":"string","description":"Description of the error"}}},"LegacyError":{"required":["code","message"],"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable error message"},"details":{"type":"array","description":"Field-level error details. Only present for validation errors.","nullable":true,"items":{"$ref":"#/components/schemas/LegacyFieldError"}}},"deprecated":true},"LegacyFieldError":{"required":["field","message"],"type":"object","properties":{"field":{"type":"string","description":"The field that caused the error"},"message":{"type":"string","description":"Description of the field error"}},"deprecated":true}}},"paths":{"/v1/employees/{employeeId}":{"delete":{"tags":["List Employees"],"summary":"Delete an employee that is still in onboarding","description":"Deletes an employee by ID that is still in onboarding.\n","operationId":"deleteEmployee","parameters":[{"name":"employeeId","in":"path","description":"Unique identifier for the employee","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Employee successfully deleted"},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict - resource already exists or state conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable entity - validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unavailable - upstream dependency error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
---
# 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://developer.usemultiplier.com/api-reference/employee-management/list-employees.md?ask=&goal=
```
`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.