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): matchesnameandlegal_namecountry_code(string, optional): ISO country code, for exampleUS,DElimit(number, optional): page size (default100, max200)offset(number, optional): pagination offset (default0)
Visibility
Results depend on the caller's team context.
Without a team (no team membership resolved from the token):
- Only suppliers with
enabled = trueandpublic_enabled = trueare 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 = trueare included, even if they are not publicly enabled. - Suppliers the team has explicitly disabled (
enabled = falsein 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:
idnamelegal_namedescriptioncountry_codewebsiteiconis_sub_storeparent_supplier_id
Explicitly Excluded Sensitive Fields
The endpoint never returns supplier credentials or internal connection secrets:
api_endpointapi_keyapi_secretclient_secretcustomer_idaccess_tokenaccess_token_expires