v1

latestOpenAPI 3.1.02026-07-24300110.4 KB

GET Questionnaires

Gets all questionnaires with optional filters

get/v2/questionnaires

Query parameters

status'processing' | 'started' | 'ready_for_review' | 'approved' | 'completed'
product_line_idsstring

Comma-separated list of product line UUIDs. You can the list of available UUIDs by hitting the GET Product Lines endpoint.

created_at_startstring date

Questionnaires created on or after this date (YYYY-MM-DD)

completed_at_startstring date

Questionnaires completed on or after this date (YYYY-MM-DD)

due_at_startstring date

Questionnaires due on or after this date (YYYY-MM-DD)

due_at_endstring date

Questionnaires due on or before this date (YYYY-MM-DD)

pageinteger

Page number for pagination.

per_pageinteger

Number of results per page.

Headers

X-API-KEYstring

Your Conveyor API key

Response

200

Example response

{
  "_embedded": {
    "questionnaires": [
      {
        "id": "f38b1e70-9d8c-4e02-b111-945b06fe3f1f",
        "created_at": "2023-08-17T21:25:31.006Z",
        "updated_at": "2023-09-01T23:39:58.603Z",
        "_type": "questionnaire",
        "status": "started",
        "name": "Questionnaire 1",
        "assignee": {
          "id": "98143302-1cf9-1827-rfb6-970pe1ae1493",
          "name": "User 1",
          "email": "assignedUser@conveyor.com"
        },
        "connection": {
          "id": "42f0a32f-cb78-4844-93bd-1ddf54a7417f",
          "created_at": "2023-08-17T21:25:30.980Z",
          "updated_at": "2023-08-17T21:25:30.980Z",
          "_type": "exchange/connection",
          "domain": "dev2-10suggests-2.com"
        },
        "product_lines": [
          {
            "id": "179a2aee-b125-4710-b94b-d5e485f50320",
            "created_at": "2023-07-06T16:43:46.480Z",
            "updated_at": "2023-07-13T17:10:09.941Z",
            "_type": "product_line",
            "program_id": "415aa20d-4bc3-414c-9287-1d4d2b0d9d49",
            "name": "Product 1",
            "publicly_accessible": true,
            "in_use": true
          }
        ],
        "question_count": 100,
        "original_format": "file",
        "due_at": "2023-08-22T21:25:13.169Z"
      }
    ]
  }
}