Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Benefits

Get benefit

Get benefit by id

Required scopes: flex.collaboration.benefits.read

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

Path parameters

benefitIdstring required

benefit id

orgSlugstring required

organization slug

Response

_idstring

The _id of the benefit.

namestring

The name of the benefit.

descriptionstring

A short description of the benefit.

contentstring

A longer description of the benefit.

urlstring

An external URL associated with the benefit.

imagestring

The image of the benefit.

coverImagestring

The cover image of the benefit.

categorystring

The category of the benefit. If you create multiple benefits with matching categories, they'll be grouped in the members portal under the same category.

locationsstring[]

An array containing the _ids of locations for which the benefit applies. If left empty the benefit will apply for all locations.

Example response

{
  "_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"
  ]
}