---
updatedAt: 2026-05-14T14:32:15.000Z
agentTools:
  projectIndex: https://docs.oysterhr.com/v0.1/llms.txt
---

# Retrieve entitlements

Returns entitlements for each engagement of the company.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Endpoints",
    "version": "v0.1"
  },
  "components": {
    "securitySchemes": {
      "bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "meta": {
        "type": "object",
        "properties": {
          "items": {
            "type": "integer"
          },
          "count": {
            "type": "integer"
          },
          "page": {
            "type": "integer"
          },
          "pages": {
            "type": "integer"
          },
          "firstUrl": {
            "type": "string"
          },
          "lastUrl": {
            "type": "string"
          },
          "pageUrl": {
            "type": "string"
          },
          "nextUrl": {
            "type": "string"
          },
          "prevUrl": {
            "type": "string"
          },
          "deprecation": {
            "type": "object",
            "properties": {
              "at": {
                "type": "string"
              },
              "sunset": {
                "type": "string"
              },
              "link": {
                "type": "object",
                "properties": {
                  "rel": {
                    "type": "string"
                  },
                  "url": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "required": [
          "items",
          "count",
          "page",
          "pages",
          "firstUrl",
          "lastUrl",
          "pageUrl",
          "nextUrl",
          "prevUrl"
        ]
      },
      "timeOffEngagementDetails": {
        "type": "object",
        "properties": {
          "engagementId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "pattern": "^[a-z_]+$"
          },
          "countryCode": {
            "type": "string"
          }
        },
        "required": [
          "engagementId",
          "name",
          "type",
          "countryCode"
        ]
      },
      "timeOffEntitlement": {
        "type": "object",
        "properties": {
          "engagement": {
            "$ref": "#/components/schemas/timeOffEngagementDetails"
          },
          "annualEntitlement": {
            "type": "number",
            "format": "float"
          },
          "accrued": {
            "type": "number",
            "format": "float"
          },
          "carried": {
            "type": "number",
            "format": "float"
          },
          "adjustedAdhoc": {
            "type": "number",
            "format": "float"
          },
          "taken": {
            "type": "number",
            "format": "float"
          },
          "upcoming": {
            "type": "number",
            "format": "float"
          },
          "projectedBalance": {
            "type": "number",
            "format": "float"
          },
          "units": {
            "type": "string",
            "enum": [
              "DAYS"
            ]
          },
          "availableBalance": {
            "type": "number",
            "format": "float"
          }
        }
      },
      "timeOffEntitlements": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/timeOffEntitlement"
        }
      }
    }
  },
  "paths": {
    "/v0.1/time_off/entitlements": {
      "get": {
        "summary": "Retrieve entitlements",
        "tags": [
          "Time Off",
          "time_off",
          "@oysterhr/prepay"
        ],
        "description": "Returns entitlements for each engagement of the company.",
        "security": [
          {
            "bearer_auth": [
              "read"
            ]
          }
        ],
        "parameters": [
          {
            "name": "per_page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful",
            "content": {
              "application/json": {
                "examples": {
                  "No engagements": {
                    "value": {
                      "data": [],
                      "meta": {
                        "items": 100,
                        "count": 0,
                        "page": 1,
                        "pages": 1,
                        "firstUrl": "/v0.1/time_off/entitlements?perPage=100&page=1",
                        "lastUrl": "/v0.1/time_off/entitlements?perPage=100&page=1",
                        "pageUrl": "/v0.1/time_off/entitlements?perPage=100&page=1",
                        "nextUrl": "/v0.1/time_off/entitlements?perPage=100&page=",
                        "prevUrl": "/v0.1/time_off/entitlements?perPage=100&page="
                      }
                    }
                  },
                  "Successful": {
                    "value": {
                      "data": [
                        {
                          "engagement": {
                            "engagementId": "A5540727",
                            "name": "Brad Doe",
                            "type": "employment",
                            "countryCode": "GB"
                          },
                          "annualEntitlement": 30,
                          "accrued": 30,
                          "carried": 0,
                          "adjustedAdhoc": 0,
                          "taken": 0,
                          "availableBalance": 29,
                          "upcoming": 0,
                          "projectedBalance": 29,
                          "units": "DAYS"
                        },
                        {
                          "engagement": {
                            "engagementId": "C6c9d557",
                            "name": "John Mark",
                            "type": "employment",
                            "countryCode": "GB"
                          },
                          "annualEntitlement": 24.5,
                          "accrued": 24.5,
                          "carried": 0,
                          "adjustedAdhoc": 0,
                          "taken": 0,
                          "availableBalance": 24.5,
                          "upcoming": 0,
                          "projectedBalance": 24.5,
                          "units": "DAYS"
                        }
                      ],
                      "meta": {
                        "items": 100,
                        "count": 2,
                        "page": 1,
                        "pages": 1,
                        "firstUrl": "/v0.1/time_off/entitlements?perPage=100&page=1",
                        "lastUrl": "/v0.1/time_off/entitlements?perPage=100&page=1",
                        "pageUrl": "/v0.1/time_off/entitlements?perPage=100&page=1",
                        "nextUrl": "/v0.1/time_off/entitlements?perPage=100&page=",
                        "prevUrl": "/v0.1/time_off/entitlements?perPage=100&page="
                      }
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/timeOffEntitlements"
                    },
                    "meta": {
                      "$ref": "#/components/schemas/meta"
                    }
                  },
                  "required": [
                    "data",
                    "meta"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oysterhr.com",
      "description": "Production server"
    },
    {
      "url": "https://api-sandbox.oysterhr.com",
      "description": "Sandbox server"
    }
  ]
}
```