API referenceEndpoints
Receptionists
Receptionists and their phone numbers.
List receptionists
/v1/receptionistsScopereceptionists:read
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 receptionists.
dataarray of ReceptionistRequiredThis page of results.
Receptionist fields
idstring (uuid)RequiredReceptionist id.
namestringRequiredName.
statusstringRequiredStatus.
One of:
active,pausedvoiceobjectRequiredFields
providerstringRequiredVoice provider.
idstringRequiredVoice id.
greetingstringRequiredWhat it says when it answers.
transfer_numberstringRequiredWhere it transfers callers, or empty.
booking_enabledbooleanRequiredWhether it books appointments.
messages_enabledbooleanRequiredWhether it takes messages.
numbersarray of PhoneNumberRequiredNumbers it answers.
PhoneNumber fields
idstring (uuid)RequiredNumber id.
numberstringRequiredThe number (E.164).
namestringRequiredIts label.
receptionist_idstring (uuid) or nullRequiredThe receptionist answering it.
created_atstring (date-time)RequiredAdded.
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/receptionists \
-H "Authorization: Bearer $ASSISTCALL_TOKEN"Example response (200)
{
"data": [
{
"id": "d4b8f2a6-1c3e-4a5b-9d7f-8e6c4a2b0d35",
"name": "Mia",
"status": "active",
"voice": {
"provider": "openai",
"id": "marin"
},
"greeting": "Thanks for calling Demo Dental! This is Mia. How can I help you today?",
"transfer_number": "",
"booking_enabled": true,
"messages_enabled": true,
"numbers": [
{
"id": "7f3c1e5a-9b2d-4e6f-a8c0-1d3b5f7e9a46",
"number": "+12125550101",
"name": "Demo Dental",
"receptionist_id": "d4b8f2a6-1c3e-4a5b-9d7f-8e6c4a2b0d35",
"created_at": "2026-09-02T17:20:00.000Z"
}
],
"created_at": "2026-09-02T17:20:00.000Z",
"updated_at": "2026-09-02T17:20:00.000Z"
}
],
"has_more": false,
"next_cursor": null
}Get a receptionist
/v1/receptionists/{id}Scopereceptionists:read
Partner keys send the client's account id in AssistCall-Account.
Path parameters
idstring (uuid)RequiredThe receptionist'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 receptionist.
idstring (uuid)RequiredReceptionist id.
namestringRequiredName.
statusstringRequiredStatus.
One of:
active,pausedvoiceobjectRequiredFields
providerstringRequiredVoice provider.
idstringRequiredVoice id.
greetingstringRequiredWhat it says when it answers.
transfer_numberstringRequiredWhere it transfers callers, or empty.
booking_enabledbooleanRequiredWhether it books appointments.
messages_enabledbooleanRequiredWhether it takes messages.
numbersarray of PhoneNumberRequiredNumbers it answers.
PhoneNumber fields
idstring (uuid)RequiredNumber id.
numberstringRequiredThe number (E.164).
namestringRequiredIts label.
receptionist_idstring (uuid) or nullRequiredThe receptionist answering it.
created_atstring (date-time)RequiredAdded.
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/receptionists/7d3c5a2e-9b1f-4c6a-8e2d-1f0a9b8c7d6e \
-H "Authorization: Bearer $ASSISTCALL_TOKEN"Example response (200)
{
"id": "d4b8f2a6-1c3e-4a5b-9d7f-8e6c4a2b0d35",
"name": "Mia",
"status": "active",
"voice": {
"provider": "openai",
"id": "marin"
},
"greeting": "Thanks for calling Demo Dental! This is Mia. How can I help you today?",
"transfer_number": "",
"booking_enabled": true,
"messages_enabled": true,
"numbers": [
{
"id": "7f3c1e5a-9b2d-4e6f-a8c0-1d3b5f7e9a46",
"number": "+12125550101",
"name": "Demo Dental",
"receptionist_id": "d4b8f2a6-1c3e-4a5b-9d7f-8e6c4a2b0d35",
"created_at": "2026-09-02T17:20:00.000Z"
}
],
"created_at": "2026-09-02T17:20:00.000Z",
"updated_at": "2026-09-02T17:20:00.000Z"
}List phone numbers
/v1/numbersScopereceptionists:read
The account's active numbers and the receptionist answering each.
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 numbers.
dataarray of PhoneNumberRequiredThis page of results.
PhoneNumber fields
idstring (uuid)RequiredNumber id.
numberstringRequiredThe number (E.164).
namestringRequiredIts label.
receptionist_idstring (uuid) or nullRequiredThe receptionist answering it.
created_atstring (date-time)RequiredAdded.
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/numbers \
-H "Authorization: Bearer $ASSISTCALL_TOKEN"Example response (200)
{
"data": [
{
"id": "7f3c1e5a-9b2d-4e6f-a8c0-1d3b5f7e9a46",
"number": "+12125550101",
"name": "Demo Dental",
"receptionist_id": "d4b8f2a6-1c3e-4a5b-9d7f-8e6c4a2b0d35",
"created_at": "2026-09-02T17:20:00.000Z"
}
],
"has_more": false,
"next_cursor": null
}