> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get agents

> StateSet Voice API operation.

StateSet Voice API operation.

### Response

`object`

<ResponseField name="ok" type="boolean" required />

<ResponseField name="agent_id" type="string (uuid)" required>
  Id of the tenant's published voice\_receptionist agent
</ResponseField>

<ResponseField name="agent_name" type="string,null" required>
  Display name the agent introduces itself with
</ResponseField>

<ResponseField name="voice" type="string,null" required>
  Voice id from the voice catalog (see GET /customer/voices)
</ResponseField>

<ResponseField name="greeting" type="string,null" required>
  Greeting line spoken when a call connects
</ResponseField>

<ResponseField name="instructions" type="string,null" required>
  System instructions the agent follows
</ResponseField>

<ResponseField name="realtime_model" type="string,null" required>
  Realtime model the agent runs on
</ResponseField>

<ResponseField name="business_profile" type="BusinessProfile,null" required>
  Guided business profile when the agent is still wizard-authored, so the app can render the guided form. Null once the customer has hand-edited their instructions and owns them.

  <Expandable title="BusinessProfile">
    <ResponseField name="business_name" type="string" required>
      Trading name, used in the greeting and throughout the prompt.
    </ResponseField>

    <ResponseField name="description" type="string,null">
      One line on what the business does ('family dental practice').
    </ResponseField>

    <ResponseField name="faqs" type="Faq[]">
      Questions the agent should be able to answer without escalating.

      <Expandable title="Faq">
        <ResponseField name="answer" type="string" required />

        <ResponseField name="question" type="string" required />
      </Expandable>
    </ResponseField>

    <ResponseField name="hours" type="string,null">
      Free-text hours ('Mon-Fri 9-5, closed weekends').
    </ResponseField>

    <ResponseField name="location" type="string,null">
      Address or service area.
    </ResponseField>

    <ResponseField name="notes" type="string,null">
      Anything else the owner wants the agent to know or avoid.
    </ResponseField>

    <ResponseField name="services" type="string[]">
      Things the business offers; the agent may discuss these.
    </ResponseField>

    <ResponseField name="transfer_to" type="string,null">
      E.164 number to transfer a caller to when they ask for a human.
    </ResponseField>
  </Expandable>
</ResponseField>

### Status codes

| Code  | Meaning                                                                                 |
| ----- | --------------------------------------------------------------------------------------- |
| `200` | Current receptionist agent configuration: voice, greeting, instructions, realtime model |
| `404` | Customer self-serve plane disabled                                                      |
| `409` | No receptionist agent configured for this tenant                                        |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.voice.stateset.com/api/v1/customer/agent' \
    --header "Authorization: Bearer $STATESET_VOICE_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "ok": true,
    "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "agent_name": "string",
    "voice": "eve",
    "greeting": "string",
    "instructions": "Two-person tent, green — replacement for damaged pole set.",
    "realtime_model": "string",
    "business_profile": {
      "business_name": "string",
      "description": "Two-person tent, green — replacement for damaged pole set.",
      "faqs": [
        {
          "answer": null,
          "question": null
        }
      ],
      "hours": "string",
      "location": "string",
      "notes": "Two-person tent, green — replacement for damaged pole set.",
      "services": [
        "string"
      ],
      "transfer_to": "string"
    }
  }
  ```
</ResponseExample>