---
updatedAt: 2026-05-07T17:21:34.000Z
agentTools:
  projectIndex: https://docs.api.workleap.com/llms.txt
---

# Get engagement scores

Get organization engagement scores

# OpenAPI definition

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "Officevibe API",
    "description": "The Officevibe API allows you to get data and insights from Officevibe to integrate with your own systems and workflows.",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://api.workleap.com/officevibe"
    }
  ],
  "paths": {
    "/engagement/scores": {
      "get": {
        "tags": [
          "Engagement"
        ],
        "summary": "Get engagement scores",
        "description": "Get organization engagement scores",
        "operationId": "GetEngagementScores",
        "parameters": [
          {
            "name": "groupIds",
            "in": "query",
            "description": "The ids of the groups to filter scores by. If null or empty, it retrieves scores for the all company. Example: ?groupIds=fa3e88b0-a07b-40a2-b118-f157237ddc65&groupIds=57b327b4-d5fe-46db-92f5-2c26ae0c05ad",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            }
          },
          {
            "name": "fromDate",
            "in": "query",
            "description": "The start date to filter scores by. When granularity is Weekly, automatically set to the previous Sunday. When granularity is Daily and omitted, defaults to 90 days before the end date.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "toDate",
            "in": "query",
            "description": "The end date to filter scores by. When granularity is Weekly, automatically set to the previous Sunday. When granularity is Daily, defaults to the current day if omitted.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "continuationToken",
            "in": "query",
            "description": "The continuation token for pagination to retrieve the next set of results. Use the token from the previous response to continue pagination.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "granularity",
            "in": "query",
            "description": "The score granularity. Weekly (default) returns one score per week; dates are clamped to the previous Sunday. Daily returns one score per day; limited to a 90-day inclusive range.",
            "schema": {
              "$ref": "#/components/schemas/ScoreGranularity"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WeeklyEngagementScoresDtoPagedResult"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          }
        },
        "x-spectral-ignore-pagination-response": true
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorDetail": {
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "ErrorResponse": {
        "required": [
          "error"
        ],
        "type": "object",
        "properties": {
          "error": {
            "$ref": "#/components/schemas/ErrorDetail"
          }
        },
        "additionalProperties": false
      },
      "PagedResultMetadata": {
        "type": "object",
        "properties": {
          "continuationToken": {
            "type": "string",
            "nullable": true
          },
          "pageSize": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "totalCount": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ScoreGranularity": {
        "enum": [
          "Weekly",
          "Daily"
        ],
        "type": "string",
        "default": "Weekly"
      },
      "WeeklyEngagementMetric": {
        "type": "object",
        "properties": {
          "metricId": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "WeeklyEngagementScoresDto": {
        "required": [
          "date",
          "groupDisplayName",
          "groupId",
          "metrics"
        ],
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "groupId": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
          },
          "groupDisplayName": {
            "type": "string",
            "readOnly": true
          },
          "nps": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "readOnly": true
          },
          "engagementScore": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "readOnly": true
          },
          "participationRate": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "readOnly": true
          },
          "metrics": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WeeklyEngagementMetric"
            },
            "readOnly": true
          }
        },
        "additionalProperties": false
      },
      "WeeklyEngagementScoresDtoPagedResult": {
        "required": [
          "data",
          "metadata"
        ],
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WeeklyEngagementScoresDto"
            }
          },
          "metadata": {
            "$ref": "#/components/schemas/PagedResultMetadata"
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "workleap-subscription-key": {
        "type": "apiKey",
        "name": "workleap-subscription-key",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "workleap-subscription-key": []
    }
  ]
}
```