List attendance periods.

get

https://api.personio.de/v2/attendance-periods

List attendance periods by given filters.

Query Params

cursor

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.

limit

integer

1 to 100

Defaults to 100

The maximum number of attendance periods returned per request.

array of strings

Filter results matching any of the provided attendance periods' ids.

person.id

array of strings

Filter results matching any of the provided persons' ids.

person.id

start.date_time.gte

string

Matches attendance periods starting from (inclusive) the provided date-time.

start.date_time.lte

string

Matches attendance periods starting before or at the provided date-time.

end.date_time.lte

string

Matches attendance periods ending before or at the provided date-time.

end.date_time.gte

string

Matches attendance periods ending after or at the provided date-time.

updated_at.gte

string

Filter out attendance periods updated before the provided date-time.

updated_at.lte

string

Filter out attendance periods updated after the provided date-time.

attribution_date.gte

date

Matches attendance periods that are attributed to or after the provided date.

attribution_date.lte

date

Matches attendance periods that are attributed to or before the provided date.

project.id

array of strings

Matches attendance periods associated with any of the provided project IDs.

project.id

status

string

enum

Status of attendance periods to filter by.

Allowed:

sort

string

Comma-separated list of fields to sort by. Prefix a field with - for descending order. Ascending has nulls last and DESC has nulls first Allowed fields: person.id, start.date_time, end.date_time, updated_at, status. Default sort order is person.id,start.date_time,end.date_time (all ascending).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful response

403Forbidden

422Invalid request