Get Buyer Users

GET /buyers/{buyerId}/buyer_users

Api key auth

Get a list of buyer users

Path parameters

buyerId string(guid) Required

ID of the buyer to return users for

Query parameters

page integer(int32)

Page Number
limit integer(int32)

Number of items per page

Responses

200 application/json

A list of buyer users
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.
  
  full_name string
  
  email string(email)
  
  role string
  
  Values are owner or user.
  
  status string
  
  Values are active, inactive, or invited.
  
  created_at string(date-time)
  
  updated_at string(date-time)

GET /buyers/{buyerId}/buyer_users

curl \
 --request GET 'https://stg.getfoundation.com/api/external/v1/buyers/{buyerId}/buyer_users' \
 --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",
      "full_name": "John Doe",
      "email": "hello@example.com",
      "role": "owner",
      "status": "active",
      "created_at": "2025-05-04T09:42:00Z",
      "updated_at": "2025-05-04T09:42:00Z"
    }
  ]
}