> ## 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.

# Search

> StateSet Voice API operation.

StateSet Voice API operation.

### Query parameters

<ParamField query="area_code" type="string" required>
  3-digit US area code to search for available Twilio numbers
</ParamField>

### Response

`object`

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

<ResponseField name="numbers" type="object[]" required>
  <Expandable title="numbers">
    <ResponseField name="phone_number" type="string" required>
      E.164 number available for purchase
    </ResponseField>

    <ResponseField name="locality" type="string,null" required>
      City the number is homed in
    </ResponseField>

    <ResponseField name="region" type="string,null" required>
      State or region code
    </ResponseField>
  </Expandable>
</ResponseField>

### Status codes

| Code  | Meaning                                                            |
| ----- | ------------------------------------------------------------------ |
| `200` | Available phone numbers matching the requested area code           |
| `400` | area\_code must be 3 digits                                        |
| `402` | Payment method required                                            |
| `404` | Number provisioning disabled or customer self-serve plane disabled |
| `502` | Number provider (Twilio) error                                     |

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

<ResponseExample>
  ```json 200 theme={null}
  {
    "ok": true,
    "numbers": [
      {
        "phone_number": "+14155551234",
        "locality": "San Francisco",
        "region": "CA"
      }
    ]
  }
  ```
</ResponseExample>