Surveys

List Surveys Responses

List survey responses requested by the user.

GET
/surveys.responses.list
AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Query Parameters

created_by?array<string>

Filters for survey responses created by any of these users.

cursor?string

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

Formattext
dispatch_ids?array<string>

Filters for survey responses associated with these unique IDs.

limit?integer

The maximum number of survey responses to return. If not set, then the default is '50'.

Formatint32
mode?string

The iteration mode to use, otherwise if not set, then "after" is used.

Value in"after" | "before"
objects?array<string>

Filters for survey responses created for the objects.

recipient?array<string>

Filters for survey responses dispatched to any of these users.

sort_by?array<string>

Fields to sort the survey responses by and the direction to sort them.

stages?array<integer>

Filters for survey response stages.

surveys?array<string>

Filters for survey responses for the provided survey IDs.

Response Body

curl -X GET "https://api.devrev.ai/surveys.responses.list?created_by=DEVU-12345&cursor=string&dispatch_ids=string&limit=0&mode=after&objects=ACC-12345&recipient=DEVU-12345&sort_by=string&stages=0&surveys=string"
{
  "next_cursor": "string",
  "prev_cursor": "string",
  "survey_responses": [
    {
      "created_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "created_date": "2023-01-01T12:00:00.000Z",
      "display_id": "string",
      "id": "string",
      "modified_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "modified_date": "2023-01-01T12:00:00.000Z",
      "dispatch_id": "string",
      "dispatched_channels": [
        {
          "id": 0,
          "label": "string",
          "ordinal": 0,
          "value": null
        }
      ],
      "object": "string",
      "recipient": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "response": {},
      "response_channel": {
        "id": 0,
        "label": "string",
        "ordinal": 0,
        "value": null
      },
      "stage": {
        "id": 0,
        "label": "string",
        "ordinal": 0,
        "value": null
      },
      "survey": "string"
    }
  ]
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}