Skip to content
REST API

Suppliers Endpoint

List available suppliers with safe field allowlisting and credential redaction.
GET https://api.elexess.com/functions/v1/suppliers

Authentication

  • JWT or team API token (el_live_*)

Query Parameters

  • q (string, optional): matches name and legal_name
  • country_code (string, optional): ISO country code, for example US, DE
  • limit (number, optional): page size (default 100, max 200)
  • offset (number, optional): pagination offset (default 0)

Visibility

Results depend on the caller's team context.

Without a team (no team membership resolved from the token):

  • Only suppliers with enabled = true and public_enabled = true are returned.

With a team (team API token or JWT with team membership):

  • All public suppliers (public_enabled = true) are included.
  • Suppliers the team has configured in Team Supplier Keys with enabled = true are included, even if they are not publicly enabled.
  • Suppliers the team has explicitly disabled (enabled = false in Team Supplier Keys) are excluded, even if they are publicly enabled.

Response

{
  "count": 1,
  "limit": 100,
  "offset": 0,
  "rows": [
    {
      "id": 8,
      "name": "Digi-Key",
      "legal_name": "Digi-Key Electronics",
      "description": "Electronic component distributor",
      "country_code": "US",
      "website": "https://www.digikey.com",
      "icon": "digikey.png",
      "is_sub_store": false,
      "parent_supplier_id": null
    }
  ]
}

Exposed Fields

Only these fields are exposed:

  • id
  • name
  • legal_name
  • description
  • country_code
  • website
  • icon
  • is_sub_store
  • parent_supplier_id

Explicitly Excluded Sensitive Fields

The endpoint never returns supplier credentials or internal connection secrets:

  • api_endpoint
  • api_key
  • api_secret
  • client_secret
  • customer_id
  • access_token
  • access_token_expires