HydraCore
API by router

Platform forms internal

List Form Submissions

GET
/internal/v1/instances/{instance_id}/form-submissions

Path Parameters

instance_id*Instance Id
Formatuuid

Query Parameters

form_id*Form Id
Formatuuid
status?string|null
limit?Limit
Range1 <= value <= 200
Default50
offset?Offset
Range0 <= value
Default0

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/form-submissions?form_id=497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
null
POST
/internal/v1/instances/{instance_id}/send-form

Path Parameters

instance_id*Instance Id
Formatuuid

Request Body

application/json
  1. body
customer_id*Customer Id
Formatuuid
form_id*Form Id
Formatuuid
initiated_via?Initiated Via
Default"agent"
respondent_person_id?|null
ttl_hours?Ttl Hours
Range1 <= value <= 720
Default168

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/send-form' \  -H 'Content-Type: application/json' \  -d '{  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",  "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843"}'
Example Response
null