GET /v1/survey_assignments — List Survey Assignments

The /v1/survey_assignments endpoint returns a paginated list of all historical, direct individual assignments of employees to surveys.

Endpoint

GET https://api.honestly.com/v1/survey_assignments

Query Parameters

integer

Maximum number of assignments to return per page. Accepts values from 0 to 1000. Defaults to 100.

integer

Number of assignments to skip before returning results. Defaults to 0.

integer

Return only the assignments that belong to this survey. Omit to return assignments across all surveys.

Example Request

curl -X GET "https://api.honestly.com/v1/survey_assignments?limit=200&offset=0" \
  -H "X-Api-Key: YOUR_SECRET_API_KEY"

Example Response

{
  "total_count": 2,
  "survey_assignments": [
    {
      "id": 1,
      "survey_id": 23,
      "created_at": "2024-01-01T00:00:00Z",
      "deleted_at": null,
      "employee_id": 1
    },
    {
      "id": 2,
      "survey_id": 23,
      "created_at": "2024-01-01T00:00:00Z",
      "deleted_at": "2024-03-15T00:00:00Z",
      "employee_id": 2
    }
  ]
}

Response Fields

integer

The total number of survey assignment records, across all pages.

array

A paginated list of survey assignment objects.

Show survey assignment object fields

integer

Unique identifier for the survey assignment.

integer

The survey this assignment belongs to.

string

RFC 3339 datetime at which the employee was assigned to the survey.

string | null

RFC 3339 datetime at which the employee was unassigned from the survey. null when the assignment is still active.

integer

The unique identifier of the assigned employee.

Join survey assignments with the employees and surveys endpoints using employee_id and survey_id to build a complete picture of participation in your data warehouse.

Employees Scores

​Endpoint

​Query Parameters

​Example Request

​Example Response

​Response Fields

Endpoint

Query Parameters

Example Request

Example Response

Response Fields