---
updatedAt: 2026-04-21T05:36:21.000Z
agentTools:
  projectIndex: https://developer.officernd.com/llms.txt
---

# Get benefits

Retrieve a list of benefits based on provided filters 

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

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v2/organizations/{orgSlug}/benefits": {
      "get": {
        "description": "Retrieve a list of benefits based on provided filters \n\n Required scopes: `flex.collaboration.benefits.read`",
        "operationId": "BenefitsController_getItems_api/v2",
        "parameters": [
          {
            "name": "createdAt",
            "required": false,
            "in": "query",
            "description": "Support date comparison filters: $gt, $gte, $lt, $lte",
            "schema": {
              "example": "createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ",
              "type": "string"
            }
          },
          {
            "name": "modifiedAt",
            "required": false,
            "in": "query",
            "description": "Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte",
            "schema": {
              "example": "modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ",
              "type": "string"
            }
          },
          {
            "name": "$select",
            "required": false,
            "in": "query",
            "description": "Select fields to return",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$cursorNext",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$cursorPrev",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$limit",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "orgSlug",
            "required": true,
            "in": "path",
            "description": "organization slug",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/PaginatedResultDto"
                    },
                    {
                      "properties": {
                        "results": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/BenefitResultDto"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "security": [
          {
            "oauth2": [
              "flex.collaboration.benefits.read"
            ]
          }
        ],
        "summary": "Get benefits",
        "tags": [
          "Benefits"
        ]
      }
    }
  },
  "info": {
    "title": "Collaboration API",
    "description": "",
    "version": "2.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://app.officernd.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://identity.officernd.com/auth/token",
            "scopes": {}
          },
          "authorizationCode": {
            "authorizationUrl": "https://identity.officernd.com/auth/authorize",
            "tokenUrl": "https://identity.officernd.com/auth/token",
            "scopes": {}
          }
        }
      }
    },
    "schemas": {
      "PaginatedResultDto": {
        "type": "object",
        "properties": {
          "rangeStart": {
            "type": "number"
          },
          "rangeEnd": {
            "type": "number"
          },
          "cursorNext": {
            "type": "string"
          },
          "cursorPrev": {
            "type": "string"
          }
        }
      },
      "BenefitResultDto": {
        "type": "object",
        "properties": {
          "_id": {
            "type": "string",
            "description": "The _id of the benefit.",
            "example": "603dfbc260f4054084125d31"
          },
          "name": {
            "type": "string",
            "description": "The name of the benefit.",
            "example": "Benefit Name"
          },
          "description": {
            "type": "string",
            "description": "A short description of the benefit.",
            "example": "Example Description"
          },
          "content": {
            "type": "string",
            "description": "A longer description of the benefit.",
            "example": "<p>Example Content</p>"
          },
          "url": {
            "type": "string",
            "description": "An external URL associated with the benefit.",
            "example": "exampleExternalLink.com"
          },
          "image": {
            "type": "string",
            "description": "The image of the benefit.",
            "example": "exampleImageLink.com"
          },
          "coverImage": {
            "type": "string",
            "description": "The cover image of the benefit.",
            "example": "exampleImageLink.com"
          },
          "category": {
            "type": "string",
            "description": "The category of the benefit. If you create multiple benefits with matching categories, \n            they'll be grouped in the members portal under the same category.",
            "example": "Example Category"
          },
          "locations": {
            "description": "An array containing the _ids of locations for which the benefit applies. \n            If left empty the benefit will apply for all locations.",
            "example": [
              "603dfbc260f4054084125f34"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```