Skip to content
Bindly Developer Docs

Get Session Detail

GET
/org/sessions/{session_id}
curl --request GET \
  --url https://engine.bindly.insure/org/sessions/example

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
session_id
required
Session Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SessionDetailResponse
object
session_id
required
Session Id
string
insured_name
required
Insured Name
string
state
Any of:
string
status
required
Status
string
form_keys
required
Form Keys
Array<string>
fields_filled
required
Fields Filled
integer
fields_total
required
Fields Total
integer
created_at
Any of:
string
updated_at
Any of:
string
field_values
required
Field Values
object
key
additional properties
any
pending_count
Any of:
integer
next_questions
Any of:
Array<object>
NextQuestion
object
key
required
Key
string
question
required
Question
string
group
required
Group
string
filled_forms
required
Filled Forms
Array<object>
FilledFormMeta
object
form_key
required
Form Key
string
fields_written
Any of:
integer
sparse_suspected
required
Sparse Suspected
boolean
warnings
Warnings
Array<string>
updated_at
Any of:
string
Examplegenerated
{
  "session_id": "example",
  "insured_name": "example",
  "state": "example",
  "status": "example",
  "form_keys": [
    "example"
  ],
  "fields_filled": 1,
  "fields_total": 1,
  "created_at": "example",
  "updated_at": "example",
  "field_values": {},
  "pending_count": 1,
  "next_questions": [
    {
      "key": "example",
      "question": "example",
      "group": "example"
    }
  ],
  "filled_forms": [
    {
      "form_key": "example",
      "fields_written": 1,
      "sparse_suspected": true,
      "warnings": [
        "example"
      ],
      "updated_at": "example"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}