Get an application

Returns the full record for one application in your workspace.

Details

Description	Fetches one application owned by the API key's workspace, with every field (unlike the list, which returns a trimmed item shape for API callers).
HTTP Method	GET
Endpoint URL	`/v1/applications/:id`
Authorization	API key as a bearer token — `Authorization: Bearer $VOYLO_API_KEY`. The application must belong to the key's workspace, otherwise `404`. See Authentication.

Request parameters

Parameter	Description	Location	Constraints	Default
`id`	The application's id.	Path	uuid (required)	—

Request example

cURL

curl https://voylo.ai/v1/applications/8f3b1c2e-9a4d-4e7f-8b21-6c5d4e3f2a1b \
  -H "Authorization: Bearer $VOYLO_API_KEY"

Success response example

200 OK

{
  "id": "8f3b1c2e-9a4d-4e7f-8b21-6c5d4e3f2a1b",
  "name": "Support hotline",
  "actionUrl": "https://api.example.com/voylo/inbound",
  "actionUrlHeaders": {},
  "xmlTemplate": null,
  "finishedUrl": null,
  "finishedUrlHeaders": {},
  "inboundTrunkId": null,
  "recording": "per_call",
  "allowedCallerIds": [],
  "createdAt": "2026-06-23T10:31:00.000Z",
  "updatedAt": "2026-06-23T10:31:00.000Z"
}

Description

iduuid — Application id.
namestring — Display name.
actionUrlstring | null — URL Voylo POSTs to at each call step to fetch fresh VoyloML.
actionUrlHeadersobject — Custom headers sent with each action-URL POST.
xmlTemplatestring | null — Static VoyloML served when no action URL is set.
finishedUrlstring | null — Post-call CDR delivery URL.
finishedUrlHeadersobject — Custom headers sent with each finished-URL POST.
inboundTrunkIduuid | null — Inbound trunk this application is attached to.
recordingenum — always · never · per_call.
allowedCallerIdsstring[] — Caller-ID allowlist; empty means any.
createdAt / updatedAttimestamp — ISO-8601 creation / last-update times.

Possible errors

Error	Description
400 Bad Request	id is not a valid UUID.
401 Unauthorized	API key is missing, invalid, or revoked.
403 Forbidden	The key's role doesn't permit this action.
404 Not Found	No application with that id in the key's workspace.

Listing applications returns a trimmed item shape for API callers — see List applications.

← Previous

List applications

Delete an application