Get Buyers

GET /buyers

Api key auth

Get a list of buyers / customers

Query parameters

page integer(int32)

Page Number
limit integer(int32)

Number of items per page

Responses

200 application/json

A list of buyers
Hide response attributes Show response attributes object
- pagination object
  
  Hide pagination attributes Show pagination attributes object
  
  current integer(int32)
  
  previous integer(int32)
  
  next integer(int32)
  
  limit integer(int32)
  
  total_pages integer(int32)
  
  total_count integer(int32)
- data array[object]
  
  Hide data attributes Show data attributes object
  
  id string(guid)
  
  System generated unique identifier. Don't include this in POST request body.
  
  company_name string
  
  company_ein string
  
  email string(email)
  
  phone string(phone)
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  zip string
  
  country string
  
  website string
  
  price_list_id string(guid)
  
  Price List ID
  
  account_manager_id string(guid)
  
  Account Manager ID
  
  created_at string(date-time)
  
  updated_at string(date-time)

GET /buyers

curl \
 --request GET 'https://stg.getfoundation.com/api/external/v1/buyers' \
 --header "X-API-Key: $API_KEY"

Response examples (200)

{
  "pagination": {
    "current": 42,
    "previous": 42,
    "next": 42,
    "limit": 42,
    "total_pages": 42,
    "total_count": 42
  },
  "data": [
    {
      "id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
      "company_name": "Acme Corp",
      "company_ein": "11-23456789",
      "email": "hello@example.com",
      "phone": "+1 123 456 7890",
      "address1": "string",
      "address2": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "string",
      "website": "string",
      "price_list_id": "string",
      "account_manager_id": "string",
      "created_at": "2025-05-04T09:42:00Z",
      "updated_at": "2025-05-04T09:42:00Z"
    }
  ]
}