--- updatedAt: 2026-05-11T06:52:42.000Z agentTools: projectIndex: https://platform.simpplr.com/llms.txt --- # Get recognition list Retrieve recognition list data with optional filtering and pagination. The response will be paginated and sorted by creation date in descending order(newest first). # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "version": "1.0.0", "title": "Simpplr User API Documentation", "description": "" }, "x-proxy-enabled": true, "tags": [ { "name": "Recognition", "description": "Everything about Recognition" } ], "servers": [ { "url": "https://{endpoint}/v1", "variables": { "env": { "default": "app" }, "endpoint": { "default": "platform.app.simpplr.com" } } } ], "paths": { "/recognition/list": { "post": { "tags": [ "Recognition" ], "summary": "Get recognition list", "description": "Retrieve recognition list data with optional filtering and pagination.\nThe response will be paginated and sorted by creation date in descending order(newest first).\n", "operationId": "getRecognitionList", "requestBody": { "description": "Get recognition list", "content": { "application/json": { "schema": { "type": "object", "properties": { "award": { "type": "array", "items": { "type": "string" }, "description": "Award names to filter by, each award name must be 100 characters or less.", "example": [ "Award one", "Award two", "Award three" ] }, "department": { "type": "array", "items": { "type": "string" }, "description": "Departments to filter by, matches departments of giver or recipient department.", "example": [ "Engineering", "Sales", "HR" ] }, "duration": { "oneOf": [ { "type": "object", "properties": { "start": { "type": "string", "description": "Start date for filtering by creation date (YYYY-MM-DD format).", "example": "2024-02-28" }, "end": { "type": "string", "description": "End date for filtering by creation date (YYYY-MM-DD format).", "example": "2024-02-28" } }, "required": [ "start" ] }, { "type": "string", "description": "Duration string in format where unit is d (days), w (weeks), m (months), or y (years).", "example": "7d" } ], "description": "Duration filter for recognition creation date." }, "location": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string", "description": "City name", "example": "Mumbai" }, "state": { "type": "string", "description": "State name", "example": "Maharashtra" }, "country": { "type": "string", "description": "Country name", "example": "India" } }, "minProperties": 1 }, "description": "Locations to filter by, matches locations of giver or recipient location.", "example": [ { "city": "Mumbai", "country": "India" }, { "state": "California", "country": "US" } ] }, "pageToken": { "type": "string", "description": "A cursor to use in pagination, must be a non-negative number as string.", "example": "1" }, "pageSize": { "type": "integer", "description": "Number of items per page (1-100, default 10).", "example": 10 }, "type": { "type": "array", "items": { "type": "string", "enum": [ "NOMINATION", "DIRECT", "PEER", "SPOT", "MILESTONE" ] }, "description": "Award types to filter by.", "example": [ "PEER", "NOMINATION", "DIRECT", "SPOT", "MILESTONE" ] }, "customField": { "type": "array", "items": { "type": "string" }, "description": "Custom field ending with __c, must be an array of strings.", "example": [ "value1", "value2" ] } } } } }, "required": false }, "responses": { "200": { "$ref": "#/components/responses/RecognitionListGetSuccess" }, "400": { "$ref": "#/components/responses/RecognitionListGetValidation" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/RecognitionListGetError" } } } } }, "components": { "responses": { "Unauthorized": { "description": "Authorize error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Missing/Invalid authentication token" } } } } } }, "Forbidden": { "description": "Forbidden error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_code": { "type": "integer", "example": 2001 }, "message": { "type": "string", "example": "Something went wrong, please try again" } } } } } }, "RecognitionListGetSuccess": { "description": "Success response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success" ] }, "message": { "type": "string", "example": "Recognition list fetched successfully" }, "result": { "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "Token for pagination to get next page of results", "example": "10" }, "listOfItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the recognition list", "example": "78d279d9-f74c-4a62-9f0b-8d9314f1df00" }, "giver": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID of the giver", "example": "13d4731d-c0c4-4c17-b7fc-7c8cf7dbcebd" }, "name": { "type": "string", "description": "Name of the giver who gave the award", "example": "Pankaj Rajwani" }, "photo": { "type": "string", "nullable": true, "description": "Profile photo URL of the giver", "example": "https://example.com/profile.jpg" }, "location": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City name", "example": "Jaipur" }, "state": { "type": "string", "nullable": true, "description": "State name", "example": "Rajsathan" }, "country": { "type": "string", "nullable": true, "description": "Country name", "example": "Uk" } } }, "department": { "type": "string", "nullable": true, "description": "Department of the giver", "example": "Engineering - Recognition" }, "type": { "type": "string", "enum": [ "USER", "APPNAME", "NO_AUTHOR", "CUSTOM" ], "description": "Type of the giver", "example": "USER" } }, "description": "Information about the giver who gave the award" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string", "description": "User ID of the recipient", "example": "4f747d0f-aa04-45e7-8af0-70a9266b56b2" }, "name": { "type": "string", "description": "Full name of the recipient", "example": "Abhishek Saini" }, "photo": { "type": "string", "nullable": true, "description": "Profile photo URL of the recipient", "example": "https://example.com/profile.jpg" }, "location": { "type": "object", "properties": { "city": { "type": "string", "nullable": true, "description": "City name", "example": "Nagpur" }, "state": { "type": "string", "nullable": true, "description": "State name", "example": "Maharashtra" }, "country": { "type": "string", "nullable": true, "description": "Country name", "example": "Toronto" } } }, "department": { "type": "string", "nullable": true, "description": "Department of the recipient", "example": "Engineering" } }, "required": [ "userId", "name" ] }, "description": "List of recipients who received the award" }, "award": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the award given", "example": "Collaborator" }, "description": { "type": "string", "nullable": true, "description": "Description of the award", "example": "Recognizes individuals or teams who demonstrate exceptional teamwork, fostering strong partnerships and open communication to achieve shared goals and drive organizational success." }, "type": { "type": "string", "enum": [ "NOMINATION", "DIRECT", "PEER", "SPOT", "MILESTONE" ], "description": "Type of recognition", "example": "PEER" }, "icon": { "type": "string", "nullable": true, "description": "Icon URL of the award", "example": "https://reco.dev.simpplr.xyz/fs/13b20301-57c3-440b-9704-73ccbe15dac3/rec/p/9b41aad4-5e4d-4a78-a9a8-d9c240bd9003/data" } }, "required": [ "name", "type" ], "description": "Award information" }, "createdOn": { "type": "string", "format": "date-time", "description": "Date and time when the recognition was created", "example": "2025-08-19T10:37:52.286Z" }, "message": { "type": "string", "nullable": true, "description": "Message HTML associated with the recognition", "example": "

Nice work @Sagar Aggarwal and @Abhishek Saini for this task

" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Name of the attachment", "example": "image.png" }, "url": { "type": "string", "nullable": true, "description": "Absolute URL (frontend-ready)", "example": "https://reco.dev.simpplr.xyz/fs/13b20301-57c3-440b-9704-73ccbe15dac3/rec/p/c4f4ec68-2b10-4953-a348-c3b4771df74f/data" }, "attachmentType": { "type": "string", "nullable": true, "description": "Type of attachment (e.g., IMAGE, FILE, VIDEO)", "example": "IMAGE" } }, "description": "Attachments related to the recognition" } } }, "required": [ "id", "recipients", "award", "createdOn" ] }, "description": "List of recognition list items" } }, "required": [ "nextPageToken", "listOfItems" ] } }, "required": [ "status", "result", "message" ] } } } }, "RecognitionListGetError": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "Unknown error occurred while fetching recognition list" } }, "required": [ "status", "message" ] } } } }, "RecognitionListGetValidation": { "description": "Bad request error", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "error" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "example": "pageToken" }, "message": { "type": "string", "example": "pageToken must be a non-negative number" } }, "required": [ "field", "message" ] } }, "message": { "type": "string", "example": "Invalid request parameters" } }, "required": [ "status", "errors", "message" ] } } } } }, "securitySchemes": { "apiAuthSecurity": { "type": "oauth2", "description": "This API uses OAuth 2 with the implicit grant flow.", "flows": { "implicit": { "authorizationUrl": "https://platform.test.simpplr.xyz/v1", "scopes": { "read": "read data", "write": "create/update data", "everything": "allow full access" } } } } } }, "security": [ { "apiAuthSecurity": [] } ] } ```