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

# Retrieve an engagement's benefits

Returns all benefits for an engagement, including assigned packages and supplementary enrollments.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Endpoints",
    "version": "v0.1"
  },
  "components": {
    "securitySchemes": {
      "bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "benefitPackage": {
        "properties": {
          "id": {
            "type": "string"
          },
          "fee": {
            "type": "object",
            "nullable": true,
            "properties": {
              "currencyCode": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3
              },
              "decimal": {
                "type": "string",
                "pattern": "^\\d+([.]\\d+)?$"
              }
            }
          },
          "name": {
            "type": "string"
          },
          "plans": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/benefitPlan"
            }
          }
        }
      },
      "benefitPlan": {
        "properties": {
          "category": {
            "type": "string"
          },
          "estimatedPrice": {
            "type": "object",
            "nullable": true,
            "properties": {
              "currencyCode": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3
              },
              "decimal": {
                "type": "string",
                "pattern": "^\\d+([.]\\d+)?$"
              }
            },
            "required": [
              "currencyCode",
              "decimal"
            ]
          },
          "fee": {
            "type": "object",
            "nullable": true,
            "properties": {
              "currencyCode": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3
              },
              "decimal": {
                "type": "string",
                "pattern": "^\\d+([.]\\d+)?$"
              }
            },
            "required": [
              "currencyCode",
              "decimal"
            ]
          },
          "guideUrl": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "link": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "enrollment": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "plan": {
            "$ref": "#/components/schemas/benefitPlan"
          },
          "package": {
            "$ref": "#/components/schemas/benefitPackage"
          },
          "employerContribution": {
            "nullable": true,
            "type": "object",
            "properties": {
              "dependents": {
                "nullable": true,
                "type": "number"
              },
              "max_dependents_covered": {
                "nullable": true,
                "type": "number"
              },
              "teamMember": {
                "nullable": true,
                "type": "number"
              }
            }
          },
          "totalCost": {
            "nullable": true,
            "type": "object",
            "properties": {
              "decimal": {
                "type": "string",
                "pattern": "^\\d+([.]\\d+)?$"
              },
              "currencyCode": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3
              }
            }
          },
          "totalEmployerContributionCost": {
            "nullable": true,
            "type": "object",
            "properties": {
              "decimal": {
                "type": "string",
                "pattern": "^\\d+([.]\\d+)?$"
              },
              "currencyCode": {
                "type": "string",
                "minLength": 3,
                "maxLength": 3
              }
            }
          },
          "coveragePeriod": {
            "nullable": true,
            "type": "object",
            "properties": {
              "fromDate": {
                "nullable": true,
                "type": "string",
                "format": "date"
              },
              "toDate": {
                "nullable": true,
                "type": "string",
                "format": "date"
              }
            }
          }
        }
      },
      "benefits": {
        "type": "object",
        "properties": {
          "assignedPackages": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "package": {
                  "$ref": "#/components/schemas/benefitPackage"
                },
                "enrollments": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/enrollment"
                  }
                }
              }
            }
          },
          "supplementary": {
            "type": "object",
            "properties": {
              "enrollments": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/enrollment"
                }
              }
            }
          }
        }
      }
    }
  },
  "paths": {
    "/v0.1/benefits/engagements/{engagement_id}/": {
      "get": {
        "summary": "Retrieve an engagement's benefits",
        "tags": [
          "Benefits"
        ],
        "description": "Returns all benefits for an engagement, including assigned packages and supplementary enrollments.",
        "security": [
          {
            "bearer_auth": [
              "read"
            ]
          }
        ],
        "parameters": [
          {
            "name": "engagement_id",
            "in": "path",
            "description": "Engagement ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful",
            "content": {
              "application/json": {
                "examples": {
                  "Successful": {
                    "value": {
                      "data": {
                        "supplementary": {
                          "enrollments": [
                            {
                              "id": "B552cefb",
                              "plan": {
                                "id": "Faf061c0",
                                "link": "http://example.com",
                                "name": "gold",
                                "providerName": "Sawayn, Schoen and Upton",
                                "category": "HEALTH",
                                "guideUrl": "http://example.com/guide",
                                "estimatedPrice": null,
                                "costSplitAllowed": false,
                                "dependentsConfig": "DISALLOWED",
                                "maxDependents": 0,
                                "minEmployerContribution": 0,
                                "supportedEngagementTypes": [],
                                "supportedEorTypes": [],
                                "mandatory": false,
                                "fee": null
                              },
                              "package": null,
                              "state": "PROVISIONED",
                              "employerContribution": {
                                "dependents": 100,
                                "maxDependentsCovered": null,
                                "teamMember": 100
                              },
                              "totalCost": null,
                              "totalEmployerContributionCost": null,
                              "coveragePeriod": {
                                "fromDate": null,
                                "toDate": null
                              }
                            }
                          ]
                        },
                        "assignedPackages": [
                          {
                            "package": {
                              "id": "A22f3158",
                              "name": "Essential package",
                              "fee": null,
                              "plans": [
                                {
                                  "id": "Bbc51b6b",
                                  "link": "http://example.com",
                                  "name": "Standard",
                                  "providerName": "Safety Wing",
                                  "category": "HEALTH",
                                  "guideUrl": "http://example.com/guide",
                                  "estimatedPrice": {
                                    "decimal": "70.00",
                                    "currencyCode": "EUR"
                                  },
                                  "costSplitAllowed": false,
                                  "dependentsConfig": "ALLOWED",
                                  "maxDependents": 0,
                                  "minEmployerContribution": 0,
                                  "supportedEngagementTypes": [
                                    "EMPLOYMENT",
                                    "CONTRACT"
                                  ],
                                  "supportedEorTypes": [
                                    "DIRECT",
                                    "INDIRECT"
                                  ],
                                  "mandatory": false
                                },
                                {
                                  "id": "C3ea2f71",
                                  "link": "http://example.com",
                                  "name": "Benefits",
                                  "providerName": "Canada Life",
                                  "category": "HEALTH",
                                  "guideUrl": "http://example.com/guide",
                                  "estimatedPrice": {
                                    "decimal": "150.00",
                                    "currencyCode": "EUR"
                                  },
                                  "costSplitAllowed": false,
                                  "dependentsConfig": "ALLOWED",
                                  "maxDependents": 0,
                                  "minEmployerContribution": 0,
                                  "supportedEngagementTypes": [
                                    "EMPLOYMENT",
                                    "CONTRACT"
                                  ],
                                  "supportedEorTypes": [
                                    "DIRECT",
                                    "INDIRECT"
                                  ],
                                  "mandatory": false
                                },
                                {
                                  "id": "D4c07300",
                                  "link": "http://example.com",
                                  "name": "Exec Class A",
                                  "providerName": "Aetna Kaiser",
                                  "category": "HEALTH",
                                  "guideUrl": "http://example.com/guide",
                                  "estimatedPrice": {
                                    "decimal": "1810.24",
                                    "currencyCode": "EUR"
                                  },
                                  "costSplitAllowed": false,
                                  "dependentsConfig": "ALLOWED",
                                  "maxDependents": 0,
                                  "minEmployerContribution": 0,
                                  "supportedEngagementTypes": [
                                    "EMPLOYMENT",
                                    "CONTRACT"
                                  ],
                                  "supportedEorTypes": [
                                    "DIRECT",
                                    "INDIRECT"
                                  ],
                                  "mandatory": false
                                }
                              ]
                            },
                            "enrollments": [
                              {
                                "id": "Ac07d38d",
                                "plan": {
                                  "id": "Ef89072f",
                                  "link": "http://example.com",
                                  "name": "standard",
                                  "providerName": "Quigley LLC",
                                  "category": "HEALTH",
                                  "guideUrl": "http://example.com/guide",
                                  "estimatedPrice": null,
                                  "costSplitAllowed": false,
                                  "dependentsConfig": "DISALLOWED",
                                  "maxDependents": 0,
                                  "minEmployerContribution": 0,
                                  "supportedEngagementTypes": [],
                                  "supportedEorTypes": [],
                                  "mandatory": false,
                                  "fee": null
                                },
                                "package": {
                                  "id": "A22f3158",
                                  "name": "Essential package",
                                  "fee": null,
                                  "plans": [
                                    {
                                      "id": "Bbc51b6b",
                                      "link": "http://example.com",
                                      "name": "Standard",
                                      "providerName": "Safety Wing",
                                      "category": "HEALTH",
                                      "guideUrl": "http://example.com/guide",
                                      "estimatedPrice": {
                                        "decimal": "70.00",
                                        "currencyCode": "EUR"
                                      },
                                      "costSplitAllowed": false,
                                      "dependentsConfig": "ALLOWED",
                                      "maxDependents": 0,
                                      "minEmployerContribution": 0,
                                      "supportedEngagementTypes": [
                                        "EMPLOYMENT",
                                        "CONTRACT"
                                      ],
                                      "supportedEorTypes": [
                                        "DIRECT",
                                        "INDIRECT"
                                      ],
                                      "mandatory": false
                                    },
                                    {
                                      "id": "C3ea2f71",
                                      "link": "http://example.com",
                                      "name": "Benefits",
                                      "providerName": "Canada Life",
                                      "category": "HEALTH",
                                      "guideUrl": "http://example.com/guide",
                                      "estimatedPrice": {
                                        "decimal": "150.00",
                                        "currencyCode": "EUR"
                                      },
                                      "costSplitAllowed": false,
                                      "dependentsConfig": "ALLOWED",
                                      "maxDependents": 0,
                                      "minEmployerContribution": 0,
                                      "supportedEngagementTypes": [
                                        "EMPLOYMENT",
                                        "CONTRACT"
                                      ],
                                      "supportedEorTypes": [
                                        "DIRECT",
                                        "INDIRECT"
                                      ],
                                      "mandatory": false
                                    },
                                    {
                                      "id": "D4c07300",
                                      "link": "http://example.com",
                                      "name": "Exec Class A",
                                      "providerName": "Aetna Kaiser",
                                      "category": "HEALTH",
                                      "guideUrl": "http://example.com/guide",
                                      "estimatedPrice": {
                                        "decimal": "1810.24",
                                        "currencyCode": "EUR"
                                      },
                                      "costSplitAllowed": false,
                                      "dependentsConfig": "ALLOWED",
                                      "maxDependents": 0,
                                      "minEmployerContribution": 0,
                                      "supportedEngagementTypes": [
                                        "EMPLOYMENT",
                                        "CONTRACT"
                                      ],
                                      "supportedEorTypes": [
                                        "DIRECT",
                                        "INDIRECT"
                                      ],
                                      "mandatory": false
                                    }
                                  ]
                                },
                                "state": "PROVISIONED",
                                "employerContribution": {
                                  "dependents": 100,
                                  "maxDependentsCovered": null,
                                  "teamMember": 100
                                },
                                "totalCost": null,
                                "totalEmployerContributionCost": null,
                                "coveragePeriod": {
                                  "fromDate": null,
                                  "toDate": null
                                }
                              }
                            ]
                          }
                        ]
                      }
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/benefits"
                    }
                  },
                  "required": [
                    "data"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oysterhr.com",
      "description": "Production server"
    },
    {
      "url": "https://api-sandbox.oysterhr.com",
      "description": "Sandbox server"
    }
  ]
}
```