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

# Search customers

GET https://api.trygrant.com/v1/customers/search

Returns customers that exactly match the provided search fields for the authenticated company.

Reference: https://docs.trygrant.com/api-reference/grant-events-api/customers/search

## Authentication

- `Authorization` header (bearer token, required) — API key obtained from the Grant dashboard

## Servers

- `https://api.trygrant.com` (Production, default)
- `http://localhost:8787` (Local development)

## Request

### Query parameters

- `name` (string, optional)
- `first_name` (string, optional)
- `last_name` (string, optional)
- `external_id` (string, optional)

## Response

### 200

Customers matched

- `success` (boolean, required)
- `customers` (list of object, required)
  - `id` (string, required)
  - `name` (string, required, nullable)
  - `first_name` (string, required, nullable)
  - `last_name` (string, required, nullable)
  - `email` (string, required, nullable)
  - `phone` (string, required, nullable)
  - `url` (string, required, nullable)
  - `external_id` (string, required, nullable)
  - `billing_address` (object, required, nullable) — Billing address
    - `country` (string, optional) — Two-letter ISO country code
    - `state` (string, optional) — State or province
    - `city` (string, optional) — City name
    - `street` (string, optional) — Street address line 1
    - `street2` (string, optional) — Street address line 2
    - `zip` (string, optional) — Postal / ZIP code
  - `shipping_address` (object, required, nullable) — Shipping address
    - `country` (string, optional) — Two-letter ISO country code
    - `state` (string, optional) — State or province
    - `city` (string, optional) — City name
    - `street` (string, optional) — Street address line 1
    - `street2` (string, optional) — Street address line 2
    - `zip` (string, optional) — Postal / ZIP code
  - `created_at` (string, required) — ISO 8601 creation timestamp
  - `updated_at` (string, required) — ISO 8601 last-updated timestamp
- `request_id` (string, required)

## Examples

**Response**

```json
{
  "success": true,
  "customers": [
    {
      "id": "cm5x9z8nv0000h85r7l9p2k1m",
      "name": "Acme Corp",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@acme.com",
      "phone": "+14155551234",
      "url": "https://acme.com",
      "external_id": "cust_ext_123",
      "billing_address": {
        "country": "US",
        "state": "CA",
        "city": "San Francisco",
        "street": "123 Main St",
        "street2": "Suite 100",
        "zip": "94105"
      },
      "shipping_address": {
        "country": "US",
        "state": "CA",
        "city": "San Francisco",
        "street": "123 Main St",
        "street2": "Suite 100",
        "zip": "94105"
      },
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-15T10:30:00.000Z"
    }
  ],
  "request_id": "req_abc123"
}
```

**SDK Code**

```typescript
import { AfternoonClient } from "grant-sdk";

async function main() {
    const client = new AfternoonClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.customers.search({});
}
main();

```

```python
import requests

url = "https://api.trygrant.com/v1/customers/search"

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

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

print(response.json())
```

```go
package main

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

func main() {

	url := "https://api.trygrant.com/v1/customers/search"

	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.trygrant.com/v1/customers/search")

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.trygrant.com/v1/customers/search")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.trygrant.com/v1/customers/search', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.trygrant.com/v1/customers/search");
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.trygrant.com/v1/customers/search")! 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()
```