API Reference
Become a Partner

List all workplaces.

get
https://api.personio.de/v2/workplaces
  • Returns a list of existing workplaces for an authorized company.
  • Supports pagination using the cursor and limit query parameters.
  • Supports filtering workplaces by name and id query parameters.
  • Supports sorting workplaces by name and id using the sort query parameter.
  • Default sort is by id in ascending order.
  • Note: This endpoint is in beta mode. Please use the discussion page in the Developer Hub for feedback.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter results matching one or more provided workplace IDs. Multiple IDs should be comma-separated.

string

The pagination cursor to navigate over to the next list of resources. If you pass a specific limit to your request, or you rely on the default value of the number of resources to be returned, then your subsequent call has to include the cursor in order to retrieve the next list of resources. If cursor is missing, the first page is returned.

integer
1 to 100
Defaults to 50

The maximum number of results to return per page.

string

Filter results matching one or more provided workplace names. Multiple names should be comma-separated.

string

Defines the sort order of results. - Use field names for ascending (e.g., name) - Use a minus sign for descending (e.g., -name) - If no sort is provided, results are returned sorted by id in ascending order.

Headers
string

As this is a Beta endpoint, the Beta header must be provided with the value true.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication information is missing or invalid.

403

The request is understood, but authorization is refused or insufficient.

Updated 5 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 5 months ago