Get a voice agent

GEThttps://api.norreach.app/v1/voice-agents/{id}

One of the AI caller's agents: its name, language, first message, script, voice and number, and whether it is published to the AI caller.

calls:readOperation id: get_voice_agent

GET/voice-agents/{id}

curl -X GET "https://api.norreach.app/v1/voice-agents/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

Get a voice agent

{
  "id": "9c0d1e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
  "object": "voice_agent",
  "name": "Nora — staffing",
  "description": "Books intro calls",
  "language": "sv",
  "first_message": "Hej, det är Nora från Example Care.",
  "script": "You call nurses who asked about shifts…",
  "voice_preset_id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
  "phone_number_id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "published": true,
  "created_at": "2026-10-01T08:00:00.000Z",
  "updated_at": "2026-11-05T08:00:00.000Z"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope calls:read. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Response

200application/json— Get a voice agent

idstring (uuid)required

An id (UUID).

object"voice_agent"required

namestring | nullrequired

descriptionstring | nullrequired

languagestring | nullrequired

first_messagestring | nullrequired

scriptstring | nullrequired

What the agent is told to do on a call (its prompt).

voice_preset_idstring (uuid) | nullrequired

phone_number_idstring (uuid) | nullrequired

publishedbooleanrequired

Live with the AI caller. Publishing (and changing a published agent's voice or tools) is done in the app.

created_atstring | nullrequired

updated_atstring | nullrequired

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
404	`not_found`	That doesn't exist.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

GET/voice-agents/{id}

curl -X GET "https://api.norreach.app/v1/voice-agents/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

Get a voice agent

{
  "id": "9c0d1e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
  "object": "voice_agent",
  "name": "Nora — staffing",
  "description": "Books intro calls",
  "language": "sv",
  "first_message": "Hej, det är Nora från Example Care.",
  "script": "You call nurses who asked about shifts…",
  "voice_preset_id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
  "phone_number_id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "published": true,
  "created_at": "2026-10-01T08:00:00.000Z",
  "updated_at": "2026-11-05T08:00:00.000Z"
}