API referenceEndpoints
Forms
Details the receptionist collects from callers, and their answers.
On this page
List intake forms
/v1/formsScopeforms:read
The details the receptionist collects from callers. Edit forms in the portal.
Partner keys send the client's account id in AssistCall-Account.
Query parameters
limitintegerHow many items to return, 1 to 100.
Default
251 to 100cursorstringThe
next_cursorof the previous page.Up to 300 characters
Headers
AssistCall-Accountstring (uuid)Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.
Responses
200A page of forms.
dataarray of FormRequiredThis page of results.
Form fields
idstring (uuid)RequiredForm id.
namestringRequiredForm name.
when_to_usestringRequiredWhen the receptionist uses it.
receptionist_idstring (uuid) or nullRequiredOnly this receptionist uses it; null: all of them.
enabledbooleanRequiredWhether it's in use.
fieldsarray of FormFieldRequiredThe questions.
FormField fields
keystringRequiredStable key; answers are keyed by it.
labelstringRequiredThe question.
typestringRequiredKind of answer.
One of:
text,number,date,time,phone,email,choice,yes_norequiredbooleanRequiredWhether the receptionist must ask for it.
optionsarray of stringRequiredChoices, for type
choice.helpstringRequiredGuidance for the receptionist.
submissionsintegerRequiredHow many answers it has.
created_atstring (date-time)RequiredCreated.
updated_atstring (date-time)RequiredLast changed.
has_morebooleanRequiredWhether there are more results after this page.
next_cursorstring or nullRequiredPass as
cursorto get the next page; null on the last page.
- 400
invalid_requestA parameter or body field is missing or invalid; the message names it. - 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 404
not_foundNo such object in this account (ids from other accounts are “not found” too). - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 400
Example request
curl https://api.assistcall.ai/v1/forms \
-H "Authorization: Bearer $ASSISTCALL_TOKEN"Example response (200)
{
"data": [
{
"id": "f1d5b9e3-7a2c-4e4b-8d6f-0a2c4e6a8c80",
"name": "New patient",
"when_to_use": "a new patient wants to book",
"receptionist_id": null,
"enabled": true,
"fields": [
{
"key": "full_name",
"label": "Full name",
"type": "text",
"required": true,
"options": [],
"help": ""
},
{
"key": "insurance",
"label": "Insurance",
"type": "text",
"required": true,
"options": [],
"help": "Provider name, or none"
},
{
"key": "how_heard",
"label": "How did you hear about us?",
"type": "choice",
"required": false,
"options": [
"Google search",
"Instagram",
"A friend"
],
"help": ""
}
],
"submissions": 2,
"created_at": "2026-09-02T17:20:00.000Z",
"updated_at": "2026-09-02T17:20:00.000Z"
}
],
"has_more": false,
"next_cursor": null
}Get a form
/v1/forms/{id}Scopeforms:read
Partner keys send the client's account id in AssistCall-Account.
Path parameters
idstring (uuid)RequiredThe form's id.
Headers
AssistCall-Accountstring (uuid)Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.
Responses
200The form.
idstring (uuid)RequiredForm id.
namestringRequiredForm name.
when_to_usestringRequiredWhen the receptionist uses it.
receptionist_idstring (uuid) or nullRequiredOnly this receptionist uses it; null: all of them.
enabledbooleanRequiredWhether it's in use.
fieldsarray of FormFieldRequiredThe questions.
FormField fields
keystringRequiredStable key; answers are keyed by it.
labelstringRequiredThe question.
typestringRequiredKind of answer.
One of:
text,number,date,time,phone,email,choice,yes_norequiredbooleanRequiredWhether the receptionist must ask for it.
optionsarray of stringRequiredChoices, for type
choice.helpstringRequiredGuidance for the receptionist.
submissionsintegerRequiredHow many answers it has.
created_atstring (date-time)RequiredCreated.
updated_atstring (date-time)RequiredLast changed.
- 400
invalid_requestA parameter or body field is missing or invalid; the message names it. - 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 404
not_foundNo such object in this account (ids from other accounts are “not found” too). - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 400
Example request
curl https://api.assistcall.ai/v1/forms/7d3c5a2e-9b1f-4c6a-8e2d-1f0a9b8c7d6e \
-H "Authorization: Bearer $ASSISTCALL_TOKEN"Example response (200)
{
"id": "f1d5b9e3-7a2c-4e4b-8d6f-0a2c4e6a8c80",
"name": "New patient",
"when_to_use": "a new patient wants to book",
"receptionist_id": null,
"enabled": true,
"fields": [
{
"key": "full_name",
"label": "Full name",
"type": "text",
"required": true,
"options": [],
"help": ""
},
{
"key": "insurance",
"label": "Insurance",
"type": "text",
"required": true,
"options": [],
"help": "Provider name, or none"
},
{
"key": "how_heard",
"label": "How did you hear about us?",
"type": "choice",
"required": false,
"options": [
"Google search",
"Instagram",
"A friend"
],
"help": ""
}
],
"submissions": 2,
"created_at": "2026-09-02T17:20:00.000Z",
"updated_at": "2026-09-02T17:20:00.000Z"
}List a form's answers
/v1/forms/{id}/submissionsScopeforms:read
One submission per call, newest first; answers is keyed by the form's field keys.
Partner keys send the client's account id in AssistCall-Account.
Path parameters
idstring (uuid)RequiredThe form's id.
Query parameters
limitintegerHow many items to return, 1 to 100.
Default
251 to 100cursorstringThe
next_cursorof the previous page.Up to 300 characters
Headers
AssistCall-Accountstring (uuid)Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.
Responses
200A page of submissions.
dataarray of FormSubmissionRequiredThis page of results.
FormSubmission fields
idstring (uuid)RequiredSubmission id.
form_idstring (uuid)RequiredForm id.
call_idstring (uuid) or nullRequiredThe call it came from.
contact_idstring (uuid) or nullRequiredThe caller's contact.
caller_namestringRequiredCaller's name.
caller_phonestringRequiredCaller's number.
answersobjectRequiredAnswers keyed by field key.
notesstringRequiredAnything else the caller said.
testbooleanRequiredFrom the owner's own test call.
created_atstring (date-time)RequiredCreated.
updated_atstring (date-time)RequiredLast changed.
has_morebooleanRequiredWhether there are more results after this page.
next_cursorstring or nullRequiredPass as
cursorto get the next page; null on the last page.
- 400
invalid_requestA parameter or body field is missing or invalid; the message names it. - 401
authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials). - 403
permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write. - 404
not_foundNo such object in this account (ids from other accounts are “not found” too). - 429
rate_limitToo many requests: wait Retry-After seconds. - 500
serverSomething went wrong on our side. Retry with backoff.
Errors share one shape. See Errors.
- 400
Example request
curl https://api.assistcall.ai/v1/forms/7d3c5a2e-9b1f-4c6a-8e2d-1f0a9b8c7d6e/submissions \
-H "Authorization: Bearer $ASSISTCALL_TOKEN"Example response (200)
{
"data": [
{
"id": "a9e3c7f1-5d8b-4b2a-9e4c-6a8e0c2e4a91",
"form_id": "f1d5b9e3-7a2c-4e4b-8d6f-0a2c4e6a8c80",
"call_id": "3a7e9c15-6d2b-4f40-8e1a-5b9c7d3e1f24",
"contact_id": "e5c9a3f7-2d4b-4c6e-8f0a-3b5d7f9c1e57",
"caller_name": "Maria Lopez",
"caller_phone": "+12125550147",
"answers": {
"full_name": "Maria Lopez",
"insurance": "Delta Dental",
"how_heard": "Google search"
},
"notes": "",
"test": false,
"created_at": "2026-10-25T13:32:16.000Z",
"updated_at": "2026-10-25T13:32:16.000Z"
}
],
"has_more": false,
"next_cursor": null
}