Search customers

GET

/v1/customers/search

GET

/v1/customers/search

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

{
  "success": true,
  "customers": [
    {
      "id": "cm5x9z8nv0000h85r7l9p2k1m",
      "name": "Acme Corp",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "[email protected]",
      "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"
}

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

Authentication

AuthorizationBearer

API key obtained from the Grant dashboard

Query parameters

namestringOptional<=255 characters

first_namestringOptional<=255 characters

last_namestringOptional<=255 characters

external_idstringOptional<=255 characters

Response

Customers matched

successboolean

customerslist of objects

request_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error