Get all shares of a contact

GET 
/v1/contacts/:id/shares

Get all shares of a contact

Request

Path Parameters

id numberrequired

Query Parameters

page number

Header Parameters

authorization stringrequired

Possible values: Value must match regular expression /Bearer [^\s]+/

Default value: Bearer <Token>

Custom Token generated from the App

Responses

200

Successful

*/*

Schema

Schema

responded

object[]

array of responded shares

Array [

sent_date daterequired

Date of survey share

survey

object

survey details

id numberrequired

id of survey

name stringrequired

name of survey

survey_type stringrequired

Possible values: [Conversational, Poll, ClassicForm, Kiosk, OfflineApp, NPS, NPSChat, CES, CESChat, CSAT, CSATChat, Employee360]

type of survey

share

object

share details

id numberrequired

id of share channel

name stringrequired

name of share channel

submission

object

submission details

id numberrequired

id of submission

state stringrequired

Possible values: [STARTED, COMPLETED]

state of submission

]

pendingResponse

object[]

array of shares pendig response

Array [

sent_date daterequired

Date of survey share

survey

object

survey details

id numberrequired

id of survey

name stringrequired

name of share channel

survey_type stringrequired

Possible values: [Conversational, Poll, ClassicForm, Kiosk, OfflineApp, NPS, NPSChat, CES, CESChat, CSAT, CSATChat, Employee360]

type of survey

share

object

share details

id numberrequired

id of share channel

name stringrequired

name of share channel

submission stringrequired

submission will be null as there is no submission

]

hasNextPage booleanrequired

Example (from schema)

{
  "responded": [
    {
      "sent_date": "2020-08-24T18:25:48.699Z",
      "survey": {
        "id": "1",
        "name": "Test Survey",
        "survey_type": "ClassicForm"
      },
      "share": {
        "id": "1",
        "name": "Test Share"
      },
      "submission": {
        "id": "1",
        "state": "COMPLETED"
      }
    }
  ],
  "pendingResponse": [
    {
      "sent_date": "2020-08-24T18:25:48.699Z",
      "survey": {
        "id": "1",
        "name": "Test Survey",
        "survey_type": "ClassicForm"
      },
      "share": {
        "id": "1",
        "name": "Test Share"
      },
      "submission": "string"
    }
  ],
  "hasNextPage": "false"
}

Loading...