v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Benefits

Get benefits

Retrieve a list of benefits based on provided filters

Required scopes: flex.collaboration.benefits.read

get/api/v2/organizations/{orgSlug}/benefits

Path parameters

orgSlugstring required

organization slug

Query parameters

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "_id": "603dfbc260f4054084125d31",
      "name": "Benefit Name",
      "description": "Example Description",
      "content": "<p>Example Content</p>",
      "url": "exampleExternalLink.com",
      "image": "exampleImageLink.com",
      "coverImage": "exampleImageLink.com",
      "category": "Example Category",
      "locations": [
        "603dfbc260f4054084125f34"
      ]
    }
  ]
}