Get forms by conversation id

GET 
/api/v2/agent/:agentCode/forms/:conversationId

Get forms by conversation id

Request

Path Parameters

agentCode stringrequired
conversationId uuidrequired

Query Parameters

culture string

Use this param to override the culture of the response. Options: - en (default) - es

Responses

200

Success

text/plain

Schema

Schema

links

object[]

nullable

Array [

method stringnullable

url stringnullable

rel stringnullable

]

conversationId uuid

form

object

version int32nullable

fields

object[]

nullable

Array [

fieldId uuid

name stringnullable

value stringnullable

date date-time

]

Example (from schema)

{
  "links": [
    {
      "method": "string",
      "url": "string",
      "rel": "string"
    }
  ],
  "conversationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "form": {
    "version": 0,
    "fields": [
      {
        "fieldId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "value": "string",
        "date": "2024-07-29T15:51:28.071Z"
      }
    ]
  }
}

application/json

Schema

Schema

links

object[]

nullable

Array [

method stringnullable

url stringnullable

rel stringnullable

]

conversationId uuid

form

object

version int32nullable

fields

object[]

nullable

Array [

fieldId uuid

name stringnullable

value stringnullable

date date-time

]

Example (from schema)

{
  "links": [
    {
      "method": "string",
      "url": "string",
      "rel": "string"
    }
  ],
  "conversationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "form": {
    "version": 0,
    "fields": [
      {
        "fieldId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "value": "string",
        "date": "2024-07-29T15:51:28.071Z"
      }
    ]
  }
}

text/json

Schema

Schema

links

object[]

nullable

Array [

method stringnullable

url stringnullable

rel stringnullable

]

conversationId uuid

form

object

version int32nullable

fields

object[]

nullable

Array [

fieldId uuid

name stringnullable

value stringnullable

date date-time

]

Example (from schema)

{
  "links": [
    {
      "method": "string",
      "url": "string",
      "rel": "string"
    }
  ],
  "conversationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "form": {
    "version": 0,
    "fields": [
      {
        "fieldId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "value": "string",
        "date": "2024-07-29T15:51:28.071Z"
      }
    ]
  }
}

401

The user is unauthorized or the session expired

403

The user does not have permission

404

The entity was not found

500

There was an unexpected error

Loading...