List Buyers

Get the Buyers collection.

get
Responses
200

OK

application/json
get
GET /public/v1/accounts/buyers HTTP/1.1
Host: api.s1.today
Accept: */*
200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-09-16T11:52:51.894Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2025-09-16T11:52:51.894Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "activated": {
          "at": "2025-09-16T11:52:51.894Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "unassigned": {
          "at": "2025-09-16T11:52:51.894Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "disabled": {
          "at": "2025-09-16T11:52:51.894Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1,
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "status": "Active",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "taxId": "text",
      "account": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active"
      },
      "errors": [
        {
          "id": "text",
          "message": "text",
          "parameters": null
        }
      ],
      "sellers": [
        {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1,
          "externalId": "text"
        }
      ]
    }
  ]
}

Last updated

Was this helpful?