---
title: "Get benefits"
method: GET
path: "/api/v2/organizations/{orgSlug}/benefits"
tags: ["Benefits"]
---

# Get benefits

`GET /api/v2/organizations/{orgSlug}/benefits`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/benefits`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.collaboration.benefits.read`

Retrieve a list of benefits based on provided filters 

 Required scopes: `flex.collaboration.benefits.read`

## Path parameters

- `orgSlug` string, required

## Query parameters

- `createdAt` string
- `modifiedAt` string
- `$select` string
- `$cursorNext` string
- `$cursorPrev` string
- `$limit` number

## Response `200`

- object
  - `rangeStart` number
  - `rangeEnd` number
  - `cursorNext` string
  - `cursorPrev` string
  - `results` BenefitResultDto[]
    - `_id` string: The _id of the benefit.
    - `name` string: The name of the benefit.
    - `description` string: A short description of the benefit.
    - `content` string: A longer description of the benefit.
    - `url` string: An external URL associated with the benefit.
    - `image` string: The image of the benefit.
    - `coverImage` string: The cover image of the benefit.
    - `category` string: 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.
    - `locations` string[]: An array containing the _ids of locations for which the benefit applies. If left empty the benefit will apply for all locations.

---

[API](https://skmtc.dev/officernd/apis/collaboration-api.md) - [All operations](https://skmtc.dev/officernd/apis/collaboration-api/llms.txt) - [OpenAPI document](https://skmtc.dev/officernd/apis/collaboration-api/revisions/f868beae3384?raw)
