Employees
Get employee records for a company.
View as MarkdownReturns a paginated list of employees associated with the specified company.
Endpoint
GET /api/v1/companies/:company_id/employeesParameters
| Parameter | Type | In | Description |
|---|---|---|---|
company_id | integer | path | The unique identifier of the company. |
page | integer | body | Page number (default: 1). |
limit | integer | body | Records per page (default: 100). |
Code Examples
Get company employees
import requests
url = 'https://api.statsnet.co/api/v1/companies/12345/employees'
headers = {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
}
response = requests.get(url, headers=headers).json()
print(response)Response
Success response
{
"ok": true,
"employees": [
{
"id": 1,
"identifier": "900101350123",
"name": "Иванов Иван Иванович",
"position": "Director",
"employer_identifier": "302233483",
"employer_name": "Company Name",
"employer_jurisdiction": "kz",
"start_date": "2020-01-15T00:00:00Z",
"end_date": null,
"created_at": "2021-01-14T00:06:22.439Z",
"updated_at": "2021-01-15T13:24:54.248Z"
}
],
"total": 1,
"pagination_total": 1,
"pagination_offset": 0
}Error Handling
Error response
{
"ok": false,
"error": {
"code": 403,
"message": "Forbidden"
}
}