---
title: "Get entitlement reports"
method: GET
path: "/api/v2/reports/entitlement_reports"
tags: ["Reports"]
---

# Get entitlement reports

`GET /api/v2/reports/entitlement_reports`

Retrieve aggregated entitlement report data grouped by configurable dimensions.

## Query parameters

- `filter` union — Filter schema for `entitlement_report` list endpoints — pass a single condition or a logical group.
  - object — A logical filter group — combine multiple conditions with the `$op` operator.
    - `$op` 'or' | 'and', required — Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match.
  - FilterEntitlementReport — Available filter parameters for querying aggregated entitlement report data.
    - `end_date` union — Filter entitlement report results by end date.
      - EndDate — unresolved $ref
      - object — Filter operator object for end date.
        - `not_eq` EndDate — unresolved $ref
        - `contains` EndDate — unresolved $ref
        - `not_contain` EndDate — unresolved $ref
        - `eq` EndDate — unresolved $ref
    - `used` union — Filter entitlement report results by used.
      - Used — unresolved $ref
      - object — Filter operator object for used.
        - `not_contain` Used — unresolved $ref
        - `eq` Used — unresolved $ref
        - `not_eq` Used — unresolved $ref
        - `contains` Used — unresolved $ref
    - `absence_type` union — Filter entitlement report results by absence type.
      - AbsenceType — unresolved $ref
      - object — Filter operator object for absence type.
        - `not_eq` AbsenceType — unresolved $ref
        - `not_contain` AbsenceType — unresolved $ref
        - `contains` AbsenceType — unresolved $ref
        - `eq` AbsenceType — unresolved $ref
    - `formulas` union — Filter entitlement report results by formulas.
      - object — Filter operator object for formulas.
        - `not_eq` Formulas — unresolved $ref
        - `contains` Formulas — unresolved $ref
        - `not_contain` Formulas — unresolved $ref
        - `eq` Formulas — unresolved $ref
      - Formulas — unresolved $ref
    - `id` union — Filter entitlement report results by id.
      - Id — unresolved $ref
      - object — Filter operator object for id.
        - `eq` Id — unresolved $ref
        - `not_eq` Id — unresolved $ref
        - `not_contain` Id — unresolved $ref
        - `contains` Id — unresolved $ref
    - `start_date` union — Filter entitlement report results by start date.
      - object — Filter operator object for start date.
        - `not_eq` StartDate — unresolved $ref
        - `not_contain` StartDate — unresolved $ref
        - `eq` StartDate — unresolved $ref
        - `contains` StartDate — unresolved $ref
      - StartDate — unresolved $ref
    - `person_id` union — Filter entitlement report results by person id.
      - PersonId — unresolved $ref
      - object — Filter operator object for person id.
        - `not_eq` PersonId — unresolved $ref
        - `contains` PersonId — unresolved $ref
        - `eq` PersonId — unresolved $ref
        - `not_contain` PersonId — unresolved $ref
    - `allocated` union — Filter entitlement report results by allocated.
      - Allocated — unresolved $ref
      - object — Filter operator object for allocated.
        - `contains` Allocated — unresolved $ref
        - `eq` Allocated — unresolved $ref
        - `not_eq` Allocated — unresolved $ref
        - `not_contain` Allocated — unresolved $ref
    - `date` union — Filter entitlement report results by date.
      - object — Filter operator object for date.
        - `not_eq` Date — unresolved $ref
        - `contains` Date — unresolved $ref
        - `eq` Date — unresolved $ref
        - `not_contain` Date — unresolved $ref
      - Date — unresolved $ref
    - `event_id` union — Filter entitlement report results by event id.
      - object — Filter operator object for event id.
        - `eq` EventId — unresolved $ref
        - `not_contain` EventId — unresolved $ref
        - `contains` EventId — unresolved $ref
        - `not_eq` EventId — unresolved $ref
      - EventId — unresolved $ref
- `group` 'absence_type' | 'end_date' | 'entitlement' | 'event' | 'organization' | 'people_custom_fields' | 'person' | 'start_date' | 'subsidiary'
- `sort` string[]

## Headers

- `X-Organization-Id` string, required

## Response `200`

Collection entitlement report

---

[API](https://skmtc.dev/productive/apis/api-documentation.md) · [All operations](https://skmtc.dev/productive/apis/api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/productive/api-documentation/revisions/bbf5057edf0d/schema)