Skip to main content
GET
/
buyers
List buyer profiles
curl --request GET \
  --url http://localhost:8000/buyers
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "buyer_id": "<string>",
      "buyer_id_type": "<string>",
      "legal_name": "<string>",
      "trade_name": "<string>",
      "contributor_status": "<string>",
      "contributor_type": "<string>",
      "address": "<string>",
      "notes": "<string>",
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "sri_last_verified_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123
}

Headers

authorization
string | null
x-api-key
string | null
x-tenant-id
string | null

Query Parameters

page
integer
default:1
Required range: x >= 1
page_size
integer
default:20
Required range: 1 <= x <= 100
name
string | null

Partial match on legal_name or trade_name

buyer_id
string | null

Exact match on buyer_id

Cookies

factio_access_token
string | null

Response

Successful Response

items
BuyerProfileResponse · object[]
required
total
integer
required
page
integer
required
page_size
integer
required
total_pages
integer
required