Survey

Survey operations

get

List surveys

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Query parameters

$limitnumberOptional

The number of records to be returned.

Default: 100

$skipnumberOptional

The number of records to be skipped for pagination.

Default: 0

$orderstringOptional

The order of the records. The result can be sorted by multiple attributes separated by a comma (,). Examples; name name asc name desc name,createdAt desc

$withstringOptional

Load related entities as objects.

attrib_namestringOptional

Filter records by attributes. The result can be filtered by any attribute of the entity. All request parameters not starting with $ are automatically used as a filter condition.

Extended filtering options are also available. See the table below.
Filter parameters that do not belong to the entity are silently ignored.
ISO-8601 formats are accepted for the date fields. The timezone will be set to UTC if not provided.
The separator for in and notin modifiers is the pipe character (|). Pipe characters can be escaped with a backslash in front of it.
Concat Like is to search for a string in two or more fields. It is only supported for JSON fields.

Description	GET Request Example
Exact Match	`name=john`
Not Equals (Exact Match)	`name:ne=john`
Is Null	`name=null`
Is Not Null	`name:ne=null`
Greater Than	`age:gt=5`, `birth:gt=1977-10-22T22:04:00`
Greater Than or Equal To	`age:gte=5`, `birth:gte=1977-10-22T22:04:00`
Less Than	`age:lt=3`, `birth:lt=2000-01-01T00:00:00`
Less Than or Equal To	`age:lte=3`, `birth:lte=2000-01-01T00:00:00`
Between	`age:bt=3,5`, `birth:bt=1977-10-22T22:04:00,2000-01-01T00:00:00`
In	status:in=value 1\|value 2\|value 3
Not In	status:notin=value 1\|value 2\|value 3
Like	`name:like=%john%`
Not Like	`name:notlike=%john%`
Concat Like(Only for JSON fields)	`firstName,lastName:concatlike=full name`

Responses

200

application/json

get

/survey

GET /survey HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

{
  "__meta": {
    "total": 1,
    "perPage": 1,
    "currentLength": 1,
    "prevUrl": 1,
    "nextUrl": 1
  },
  "data": []
}

post

Create a new Survey.

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Body

namestringOptional

Name of this survey

entitystringOptional

For which entity this survey collects data? (Profile or Resource)

Responses

201

Survey created

application/json

400

Name or entity is missing. Or provided entity is not valid.

post

/survey

POST /survey HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "text",
  "entity": "text"
}

No content

get

Get a survey by ID

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

idstringRequired

Unique ID of the survey to get

Responses

200

application/json

Responseany

404

A survey with the specified ID was not found.

get

/survey/{id}

GET /survey/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

patch

Update an existing survey

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

idstringRequired

Unique ID of the survey to update

Body

namestringOptional

Name of the survey

Responses

200

application/json

Responseany

404

A survey with the specified ID was not found.

patch

/survey/{id}

PATCH /survey/{id} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

No content

Share a survey with a network

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

idstringRequired

Unique ID of the survey to share

Body

networkstringOptional

ID of the network where to share the survey

Responses

201

Survey has been shared.

400

Network is not found or inaccessible.

post

/survey/{id}/share

POST /survey/{id}/share HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "network": "text"
}

No content

post

Unshare a survey in a network

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

idstringRequired

Unique ID of the survey to unshare

Body

networkstringOptional

ID of the network where to share the survey

Responses

200

Survey is unshared

No content

400

Network is not found or inaccessible.

post

/survey/{id}/unshare

POST /survey/{id}/unshare HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "network": "text"
}

No content

get

Read a survey form by ID

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

surveyIdstringRequired

Unique ID of the survey form to get

Responses

200

application/json

Responseany

404

A survey form with the specified ID was not found.

get

/survey-form/{surveyId}

GET /survey-form/{surveyId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

post

Create a new survey version

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

surveyIdstringRequired

Unique ID of the survey to share

Body

xmlstringOptional

XML of the survey form

Responses

201

Survey version has been created

application/json

post

/survey-form/{surveyId}

POST /survey-form/{surveyId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "xml": "text"
}

201

Survey version has been created

[]

get

List survey responses

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

surveyIdstringRequired

ID of the survey for which to list responses

includePreviousResponsesstringOptional

a parameter to determine wether or not to include the previous survey responses

Query parameters

formattedstring · enumOptional

When set to "true", appends "formattedData" to each survey response object with labels, types, and display values.

Example: truePossible values:

$limitnumberOptional

The number of records to be returned.

Default: 100

$skipnumberOptional

The number of records to be skipped for pagination.

Default: 0

$orderstringOptional

The order of the records. The result can be sorted by multiple attributes separated by a comma (,). Examples; name name asc name desc name,createdAt desc

$withstringOptional

Load related entities as objects.

attrib_namestringOptional

Filter records by attributes. The result can be filtered by any attribute of the entity. All request parameters not starting with $ are automatically used as a filter condition.

Extended filtering options are also available. See the table below.
Filter parameters that do not belong to the entity are silently ignored.
ISO-8601 formats are accepted for the date fields. The timezone will be set to UTC if not provided.
The separator for in and notin modifiers is the pipe character (|). Pipe characters can be escaped with a backslash in front of it.
Concat Like is to search for a string in two or more fields. It is only supported for JSON fields.

Description	GET Request Example
Exact Match	`name=john`
Not Equals (Exact Match)	`name:ne=john`
Is Null	`name=null`
Is Not Null	`name:ne=null`
Greater Than	`age:gt=5`, `birth:gt=1977-10-22T22:04:00`
Greater Than or Equal To	`age:gte=5`, `birth:gte=1977-10-22T22:04:00`
Less Than	`age:lt=3`, `birth:lt=2000-01-01T00:00:00`
Less Than or Equal To	`age:lte=3`, `birth:lte=2000-01-01T00:00:00`
Between	`age:bt=3,5`, `birth:bt=1977-10-22T22:04:00,2000-01-01T00:00:00`
In	status:in=value 1\|value 2\|value 3
Not In	status:notin=value 1\|value 2\|value 3
Like	`name:like=%john%`
Not Like	`name:notlike=%john%`
Concat Like(Only for JSON fields)	`firstName,lastName:concatlike=full name`

Responses

200

application/json

get

/survey/{surveyId}/response

GET /survey/{surveyId}/response HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

{
  "__meta": {
    "total": 1,
    "perPage": 1,
    "currentLength": 1,
    "prevUrl": 1,
    "nextUrl": 1
  },
  "data": [
    {
      "id": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
      "surveyId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
      "formId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
      "entityId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
      "instanceId": "uuid:12345678-1234-1234-1234-123456789012",
      "deprecatedId": "uuid:12345678-1234-1234-1234-123456789012",
      "latest": true,
      "data": {
        "field1": "value1",
        "field2": "value2"
      },
      "createdById": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
      "createdViaId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-01T00:00:00.000Z",
      "formMeta": [
        {
          "path": "field_name",
          "label": "Field Label",
          "type": "text",
          "options": [
            {
              "value": "text",
              "label": "text"
            }
          ]
        }
      ],
      "formattedData": {
        "gender": {
          "value": "male",
          "label": "Gender",
          "type": "select1",
          "displayValue": "Male"
        },
        "caller_age": {
          "value": 35,
          "label": "Some programs are age dependent - may I ask for your age?",
          "type": "number",
          "displayValue": 35
        },
        "birth_date": {
          "value": "2023-01-01",
          "displayValue": "01/01/2023",
          "label": "Date of Birth",
          "type": "date"
        },
        "languages": {
          "value": "english spanish",
          "displayValue": "English, Spanish",
          "label": "Languages Spoken",
          "type": "select"
        },
        "phone": {
          "value": "1234567890",
          "displayValue": "(123) 456-7890",
          "label": "Phone Number",
          "type": "phone"
        }
      }
    }
  ]
}

get

List all survey responses

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

includePreviousResponsesstringOptional

a parameter to determine wether or not to include the previous survey responses

Query parameters

$limitnumberOptional

The number of records to be returned.

Default: 100

$skipnumberOptional

The number of records to be skipped for pagination.

Default: 0

$orderstringOptional

The order of the records. The result can be sorted by multiple attributes separated by a comma (,). Examples; name name asc name desc name,createdAt desc

$withstringOptional

Load related entities as objects.

attrib_namestringOptional

Filter records by attributes. The result can be filtered by any attribute of the entity. All request parameters not starting with $ are automatically used as a filter condition.

Extended filtering options are also available. See the table below.
Filter parameters that do not belong to the entity are silently ignored.
ISO-8601 formats are accepted for the date fields. The timezone will be set to UTC if not provided.
The separator for in and notin modifiers is the pipe character (|). Pipe characters can be escaped with a backslash in front of it.
Concat Like is to search for a string in two or more fields. It is only supported for JSON fields.

Description	GET Request Example
Exact Match	`name=john`
Not Equals (Exact Match)	`name:ne=john`
Is Null	`name=null`
Is Not Null	`name:ne=null`
Greater Than	`age:gt=5`, `birth:gt=1977-10-22T22:04:00`
Greater Than or Equal To	`age:gte=5`, `birth:gte=1977-10-22T22:04:00`
Less Than	`age:lt=3`, `birth:lt=2000-01-01T00:00:00`
Less Than or Equal To	`age:lte=3`, `birth:lte=2000-01-01T00:00:00`
Between	`age:bt=3,5`, `birth:bt=1977-10-22T22:04:00,2000-01-01T00:00:00`
In	status:in=value 1\|value 2\|value 3
Not In	status:notin=value 1\|value 2\|value 3
Like	`name:like=%john%`
Not Like	`name:notlike=%john%`
Concat Like(Only for JSON fields)	`firstName,lastName:concatlike=full name`

Responses

200

application/json

get

/survey-response

GET /survey-response HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

{
  "__meta": {
    "total": 1,
    "perPage": 1,
    "currentLength": 1,
    "prevUrl": 1,
    "nextUrl": 1
  },
  "data": [
    {
      "id": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
      "surveyId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
      "formId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
      "entityId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
      "instanceId": "uuid:12345678-1234-1234-1234-123456789012",
      "deprecatedId": "uuid:12345678-1234-1234-1234-123456789012",
      "latest": true,
      "data": {
        "field1": "value1",
        "field2": "value2"
      },
      "createdById": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
      "createdViaId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-01T00:00:00.000Z",
      "form": {
        "id": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
        "createdAt": "2025-08-19T12:36:44.070Z",
        "updatedAt": "2025-08-19T12:36:44.070Z",
        "root_tag": "data",
        "default_language": "English"
      },
      "formattedData": {
        "gender": {
          "value": "male",
          "label": "Gender",
          "type": "select1",
          "displayValue": "Male"
        },
        "caller_age": {
          "value": 35,
          "label": "Some programs are age dependent - may I ask for your age?",
          "type": "number",
          "displayValue": 35
        },
        "birth_date": {
          "value": "2023-01-01",
          "displayValue": "01/01/2023",
          "label": "Date of Birth",
          "type": "date"
        },
        "languages": {
          "value": "english spanish",
          "displayValue": "English, Spanish",
          "label": "Languages Spoken",
          "type": "select"
        },
        "phone": {
          "value": "1234567890",
          "displayValue": "(123) 456-7890",
          "label": "Phone Number",
          "type": "phone"
        }
      }
    }
  ]
}

post

Submit a response to a survey

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

instanceIdstringOptional

The unique ID of the record

deprecatedIdstringOptional

The instanceId of the submission for which this is a revision

instancestringOptional

Raw XML submission string.

datastringOptional

Parsed submission data in JSON format

Responses

201

Survey response has been created

application/json

400

Survey response is invalid

post

/survey-response

POST /survey-response HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "instanceId": "text",
  "deprecatedId": "text",
  "instance": "text",
  "data": "text"
}

{
  "id": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "surveyId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "formId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "entityId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "instanceId": "uuid:12345678-1234-1234-1234-123456789012",
  "deprecatedId": "uuid:12345678-1234-1234-1234-123456789012",
  "latest": true,
  "data": {
    "field1": "value1",
    "field2": "value2"
  },
  "createdById": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "createdViaId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "formMeta": [
    {
      "path": "field_name",
      "label": "Field Label",
      "type": "text",
      "options": [
        {
          "value": "text",
          "label": "text"
        }
      ]
    }
  ],
  "formattedData": {
    "gender": {
      "value": "male",
      "label": "Gender",
      "type": "select1",
      "displayValue": "Male"
    },
    "caller_age": {
      "value": 35,
      "label": "Some programs are age dependent - may I ask for your age?",
      "type": "number",
      "displayValue": 35
    },
    "birth_date": {
      "value": "2023-01-01",
      "displayValue": "01/01/2023",
      "label": "Date of Birth",
      "type": "date"
    },
    "languages": {
      "value": "english spanish",
      "displayValue": "English, Spanish",
      "label": "Languages Spoken",
      "type": "select"
    },
    "phone": {
      "value": "1234567890",
      "displayValue": "(123) 456-7890",
      "label": "Phone Number",
      "type": "phone"
    }
  }
}

get

Latest survey response for the given entity id

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

surveyIdstringRequired

ID of the survey

entityIdstringRequired

Id of the entity

Query parameters

formattedstring · enumOptional

When set to "true", returns formatted survey response data with labels, types, and display values. When false or not specified, returns raw data values.

Example: truePossible values:

Responses

200

application/json

404

No survey response has been found.

get

/survey-response/{surveyId}/{entityId}

GET /survey-response/{surveyId}/{entityId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "surveyId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "formId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "entityId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "instanceId": "uuid:12345678-1234-1234-1234-123456789012",
  "deprecatedId": "uuid:12345678-1234-1234-1234-123456789012",
  "latest": true,
  "data": {
    "field1": "value1",
    "field2": "value2"
  },
  "createdById": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "createdViaId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "formMeta": [
    {
      "path": "field_name",
      "label": "Field Label",
      "type": "text",
      "options": [
        {
          "value": "text",
          "label": "text"
        }
      ]
    }
  ],
  "formattedData": {
    "gender": {
      "value": "male",
      "label": "Gender",
      "type": "select1",
      "displayValue": "Male"
    },
    "caller_age": {
      "value": 35,
      "label": "Some programs are age dependent - may I ask for your age?",
      "type": "number",
      "displayValue": 35
    },
    "birth_date": {
      "value": "2023-01-01",
      "displayValue": "01/01/2023",
      "label": "Date of Birth",
      "type": "date"
    },
    "languages": {
      "value": "english spanish",
      "displayValue": "English, Spanish",
      "label": "Languages Spoken",
      "type": "select"
    },
    "phone": {
      "value": "1234567890",
      "displayValue": "(123) 456-7890",
      "label": "Phone Number",
      "type": "phone"
    }
  }
}

get

Fetch a specific survey response

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

surveyResponseIdstringRequired

ID of the survey response

Query parameters

formattedstring · enumOptional

When set to "true", returns formatted survey response data with labels, types, and display values. When false or not specified, returns raw data values.

Example: truePossible values:

$withstringOptional

Load related entities as objects.

Responses

200

application/json

404

No survey response has been found.

get

/survey-response/{surveyResponseId}

GET /survey-response/{surveyResponseId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "surveyId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "formId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "entityId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "instanceId": "uuid:12345678-1234-1234-1234-123456789012",
  "deprecatedId": "uuid:12345678-1234-1234-1234-123456789012",
  "latest": true,
  "data": {
    "field1": "value1",
    "field2": "value2"
  },
  "createdById": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "createdViaId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "formMeta": [
    {
      "path": "field_name",
      "label": "Field Label",
      "type": "text",
      "options": [
        {
          "value": "text",
          "label": "text"
        }
      ]
    }
  ],
  "formattedData": {
    "gender": {
      "value": "male",
      "label": "Gender",
      "type": "select1",
      "displayValue": "Male"
    },
    "caller_age": {
      "value": 35,
      "label": "Some programs are age dependent - may I ask for your age?",
      "type": "number",
      "displayValue": 35
    },
    "birth_date": {
      "value": "2023-01-01",
      "displayValue": "01/01/2023",
      "label": "Date of Birth",
      "type": "date"
    },
    "languages": {
      "value": "english spanish",
      "displayValue": "English, Spanish",
      "label": "Languages Spoken",
      "type": "select"
    },
    "phone": {
      "value": "1234567890",
      "displayValue": "(123) 456-7890",
      "label": "Phone Number",
      "type": "phone"
    }
  }
}

post

Delete all survey responses related to an entity.

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

transactionIdstringOptional

ID of the active transaction

entityIdstringOptional

Applications with the privileges can opt-out of the survey on behalf of this entityId. If a non-programmatic account calls this endpoint, this parameter is obsolete and authenticated profile will be opted out.

Path parameters

surveyIdstringRequired

ID of the survey

Responses

200

Survey responses have been deleted

No content

404

Survey, entity or transaction does not exist

post

/survey/{surveyId}/opt-out/{entityId}

POST /survey/{surveyId}/opt-out/{entityId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

delete

Delete all survey responses related to an entity.

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

transactionIdstringOptional

ID of the transaction, if exists.

Path parameters

responseIdstringRequired

ID of the survey response

Responses

200

Survey response has been deleted

No content

404

Survey response or transaction does not exist

delete

/survey-response/{responseId}

DELETE /survey-response/{responseId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

post

Start a new survey session

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

surveyIdstringRequired

Unique ID of the survey to which response will be given

Body

subjectstringOptional

The ID of subject entity of this survey

redirectUrlstringOptional

The url to redirect the user after survey is submitted

transactionstringOptional

The ID of the transaction to connect the survey response

agentstringOptional

The profile ID of the agent facilitating the response

Responses

201

Survey session has been created

application/json

400

Survey session is invalid

post

/survey-session/{surveyId}

POST /survey-session/{surveyId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "subject": "text",
  "redirectUrl": "text",
  "transaction": "text",
  "agent": "text"
}

No content

get

Returns the latest survey instance for the session

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Latest survey response

application/json

401

Survey session is invalid

get

/survey-session/instance

GET /survey-session/instance HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "surveyId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "formId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "entityId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "instanceId": "uuid:12345678-1234-1234-1234-123456789012",
  "deprecatedId": "uuid:12345678-1234-1234-1234-123456789012",
  "latest": true,
  "data": {
    "field1": "value1",
    "field2": "value2"
  },
  "createdById": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "createdViaId": "HxK9POA1vfmyaENxTnbDONyUeE1j3P",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "formMeta": [
    {
      "path": "field_name",
      "label": "Field Label",
      "type": "text",
      "options": [
        {
          "value": "text",
          "label": "text"
        }
      ]
    }
  ],
  "formattedData": {
    "gender": {
      "value": "male",
      "label": "Gender",
      "type": "select1",
      "displayValue": "Male"
    },
    "caller_age": {
      "value": 35,
      "label": "Some programs are age dependent - may I ask for your age?",
      "type": "number",
      "displayValue": 35
    },
    "birth_date": {
      "value": "2023-01-01",
      "displayValue": "01/01/2023",
      "label": "Date of Birth",
      "type": "date"
    },
    "languages": {
      "value": "english spanish",
      "displayValue": "English, Spanish",
      "label": "Languages Spoken",
      "type": "select"
    },
    "phone": {
      "value": "1234567890",
      "displayValue": "(123) 456-7890",
      "label": "Phone Number",
      "type": "phone"
    }
  }
}

PreviousSite Group NextTransaction

Last updated 9 days ago