New API version v6.12.5 has been released! 🎉
REST Documentation
GET All Employees

Get All Employees

You can use this endpoint to call up a paginated list of all employees.

Request

GET /api/v1/employees
curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/employees' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Response

{
	"data": [
		{
			"username": "alexandrea.stroman",
			"firstname": "Alexandrea",
			"lastname": "Stroman",
			"personal_number": "4255",
			"street": null,
			"zip": null,
			"city": null,
			"country": null,
			"abbreviation": null,
			"salutation": {
				"id": "Frau",
				"name": "Mrs"
			},
			"title": null,
			"email": "bmarquardt@example.com",
			"phone": "+1.479.610.5337",
			"mobile": null,
			"fax": null,
			"private_phone": null,
			"birthdate": "2003-04-20T00:00:00.000000Z",
			"iban": null,
			"bic": null,
			"account_no": null,
			"bank_name": null,
			"bank_code": null,
			"currency": null,
			"release_date": null,
			"vat": null,
			"price_group": null,
			"employment": {
				"id": 0,
				"name": "Employee"
			},
			"rights": {
				"id": 3,
				"name": "user with additional authorizations"
			},
			"department_id": 1,
			"language": null,
			"personio_id": null,
			"cost_bearer": null,
			"tax_id": null,
			"created": "2024-02-14T07:41:06.000000Z",
			"modified": "2024-02-14T07:41:06.000000Z",
			"creditor_number": null
		},
		{
			"username": "alfonzo.harber"
			// ...
		}
	]
}

Optional Parameters

  • Name
    personal_number | personal_number[]
    Type
    string | array of strings
    Description

    A single personnel number or a list of personnel numbers to filter the results.

  • Name
    limit
    Type
    integer
    Description

    Attribute for limiting the number of entries per page