> This page is for version Prod (default).
> For other versions, use one of these documentation indexes:
> - Prod (default): https://docs.chrt.com/prod/llms.txt
> - Staging: https://docs.chrt.com/staging/llms.txt
> - Dev: https://docs.chrt.com/dev/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.chrt.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.chrt.com/_mcp/server.

# Typeahead

GET https://api.chrt.com/orgs/off_chrt_org_data/typeahead/v1

Returns matching name values and their IDs within the caller's organization, optionally filtered by org_type. | authz: allowed_org_types=[provider] | () -> (list[OffChrtOrgDataTypeaheadResult])

Reference: https://docs.chrt.com/api-reference/api-reference/orgs/off-chrt-org-data/typeahead-v-1

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.chrt.com` (Production, default)
- `https://api.dev.chrt.com` (Development)
- `https://api.staging.chrt.com` (Staging)
- `https://localhost:8000` (Local)

## Request

### Query parameters

- `query` (string, required) — Typeahead search query
- `limit` (integer, optional, default: 10) — Max results per field
- `filter_org_type` (enum, optional) — Filter by organization type
  - Allowed values: `provider`, `shipper`, `vendor`

## Response

### 200

Successful Response

- `list of OffChrtOrgDataTypeaheadResult`

## Errors

### 422 Off Chrt Org Data Typeahead V1request Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### OffChrtOrgDataTypeaheadResult

- `type` ("name", required)
- `values` (list of OffChrtOrgDataTypeaheadValue, required)

### ValidationError

- `loc` (list of LocationItem, required)
- `msg` (string, required)
- `type` (string, required)
- `ctx` (map from string to any, optional)
- `input` (any, optional)

### OffChrtOrgDataTypeaheadValue

- `off_chrt_org_data_ids` (list of string, required)
- `value` (string, required)

### LocationItem

- string
- integer

## Examples

**Response**

```json
[
  {
    "type": "name",
    "values": [
      {
        "off_chrt_org_data_ids": [
          "off_chrt_org_data_ids"
        ],
        "value": "value"
      }
    ]
  }
]
```

**SDK Code**

```python
import requests

url = "https://api.chrt.com/orgs/off_chrt_org_data/typeahead/v1"

querystring = {"filter_org_type":"provider","limit":"1","query":"query"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.chrt.com/orgs/off_chrt_org_data/typeahead/v1?filter_org_type=provider&limit=1&query=query';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chrt.com/orgs/off_chrt_org_data/typeahead/v1?filter_org_type=provider&limit=1&query=query"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.chrt.com/orgs/off_chrt_org_data/typeahead/v1?filter_org_type=provider&limit=1&query=query")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.chrt.com/orgs/off_chrt_org_data/typeahead/v1?filter_org_type=provider&limit=1&query=query")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.chrt.com/orgs/off_chrt_org_data/typeahead/v1?filter_org_type=provider&limit=1&query=query', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.chrt.com/orgs/off_chrt_org_data/typeahead/v1?filter_org_type=provider&limit=1&query=query");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.chrt.com/orgs/off_chrt_org_data/typeahead/v1?filter_org_type=provider&limit=1&query=query")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```