PeopleForce
GuidesAPI reference
Pulse

Early access

Company API v4 is the next-generation API and is under active development. Endpoints and fields may still change.

List all engagement survey responses

Returns a list of engagement survey responses

GET
/api/v4/pulse/engagement_survey_responses

Returns a list of engagement survey responses

Query Parameters

survey_ids?array<>

Filter by engagement survey IDs

user_ids?array<>

Filter by employee IDs

fields?array<string>

Employee custom field internal names to include

Itemsitems <= 10
created_at[gt]?string

created_at after an ISO 8601 date or timestamp

Formatdate-time
created_at[gte]?string

created_at on or after an ISO 8601 date or timestamp

Formatdate-time
created_at[lt]?string

created_at before an ISO 8601 date or timestamp

Formatdate-time
created_at[lte]?string

created_at on or before an ISO 8601 date or timestamp

Formatdate-time
updated_at[gt]?string

updated_at after an ISO 8601 date or timestamp

Formatdate-time
updated_at[gte]?string

updated_at on or after an ISO 8601 date or timestamp

Formatdate-time
updated_at[lt]?string

updated_at before an ISO 8601 date or timestamp

Formatdate-time
updated_at[lte]?string

updated_at on or before an ISO 8601 date or timestamp

Formatdate-time
page?integer

Page offset to fetch.

Formatint32
Default1
per_page?integer

Number of results to return per page.

Formatint32
Range1 <= value <= 100
Default50
offset?integer

Pad a number of results.

Formatint32
Default0

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v4/pulse/engagement_survey_responses"
{  "data": [    {      "id": 0,      "survey_id": 0,      "user_id": 0,      "anonymous": true,      "position": {        "id": 0,        "name": "string"      },      "location": {        "id": 0,        "name": "string"      },      "division": {        "id": 0,        "name": "string"      },      "department": {        "id": 0,        "name": "string"      },      "work_type": {        "id": 0,        "name": "string"      },      "gender": {        "id": 0,        "name": "string"      },      "age": "string",      "tenure": "string",      "fields": {        "property1": {          "label": "string",          "group": {            "id": 0,            "name": "string"          },          "value": null,          "option_id": 0,          "option_ids": [            0          ],          "user_id": 0        },        "property2": {          "label": "string",          "group": {            "id": 0,            "name": "string"          },          "value": null,          "option_id": 0,          "option_ids": [            0          ],          "user_id": 0        }      },      "status": "string",      "finished_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "answers": [        {          "question": {            "id": 0,            "type": "string",            "title": "string"          },          "value": "string",          "comment": "string"        }      ]    }  ],  "metadata": {    "page": 0,    "per_page": 0,    "total_pages": 0,    "total_count": 0  }}

List all engagement surveys GET

Returns a list of engagement surveys