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

# Retrieve entitlements for individual engagement

Returns entitlements for an engagement.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Endpoints",
    "version": "v0.1"
  },
  "components": {
    "securitySchemes": {
      "bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "errors": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string"
                }
              },
              "required": [
                "message"
              ]
            }
          }
        },
        "required": [
          "errors"
        ]
      },
      "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"
          }
        }
      }
    }
  },
  "paths": {
    "/v0.1/time_off/entitlements/{id}": {
      "get": {
        "summary": "Retrieve entitlements for individual engagement",
        "tags": [
          "Time Off",
          "time_off",
          "@oysterhr/prepay"
        ],
        "description": "Returns entitlements for an engagement.",
        "security": [
          {
            "bearer_auth": [
              "read"
            ]
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Engagement ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful",
            "content": {
              "application/json": {
                "examples": {
                  "Successful": {
                    "value": {
                      "data": {
                        "engagement": {
                          "engagementId": "A5540727",
                          "name": "Dr. Ines Denesik",
                          "type": "employment",
                          "countryCode": "GB"
                        },
                        "annualEntitlement": 0,
                        "accrued": 0,
                        "carried": 0,
                        "adjustedAdhoc": 0,
                        "taken": 0,
                        "availableBalance": 0,
                        "upcoming": 0,
                        "projectedBalance": 0,
                        "units": "DAYS"
                      }
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/timeOffEntitlement"
                    }
                  },
                  "required": [
                    "data"
                  ]
                }
              }
            }
          },
          "422": {
            "description": "Cannot determine entitlements for given resource",
            "content": {
              "application/json": {
                "examples": {
                  "Cannot determine entitlements for given resource": {
                    "value": {
                      "errors": [
                        {
                          "message": "The entitlements cannot be determined for given engagement."
                        }
                      ]
                    }
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/errors"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oysterhr.com",
      "description": "Production server"
    },
    {
      "url": "https://api-sandbox.oysterhr.com",
      "description": "Sandbox server"
    }
  ]
}
```