List Supplier

Endpoint URL

https://{{base_url}}/api/v2/supplier

Authentication and rate limits

Item	Details
Authentication method	OAuth 2.0 Bearer token
Rate limit	Rate Limit

Requests Example

curl --request GET \
  --url 'https://{{base_url}}/api/v2/supplier/?company=1' \
  --header 'Authorization: Bearer $BEARER_TOKEN'

curl --request GET \
  --url 'https://dashboard-api.revnue.com/api/v2/supplier/$id/?company=1' \
  --header 'Authorization: Bearer $BEARER_TOKEN'

Query Parameters

company (integer) --
[REQUIRED]
The ID of the specific company your API is calling. For accounts with only one company, the default value is 1.
To lookup a specific company ID, see the List Company API.
id (integer) --
Optional if you want to list a specific supplier ID. The id parameter is passed as part of the request url /supplier/$id/.

Response Syntax

{
  "id": integer,
  "name": "string",
  "category": {
    "id": integer,
    "name": "string"
  },
  "contact_person": {
    "name": "string",
    "email": "string",
    "type": "account_management" | "billing" | "executive" | "sales" | "support" | "technical"
  },
  "address_line_1": "string",
  "address_line_2": "string",
  "city": "string",
  "state_province": "string",
  "zip_postal_code": "string",
  "country": "string",
  "phone": "string",
  "mobile": "string",
  "fax": "string",
  "website": "string",
  "general_description": "string",
  "type": "us"|"foreign",
  "business_name": "string",
  "business_address_line_1": "string",
  "business_address_line_2": "string",
  "business_city": "string",
  "business_state_province": "string",
  "business_zip_postal_code": "string",
  "business_country": "string",
  "ein": "string",
  "financial_description": "string",
  "nda_signed": true | false,
  "nda_signed_date": "string",
  "msa_signed": true | false,
  "msa_signed_date": "string",
  "supplementary_description": "string",
  "additional_description": "string",
  "template":{
    "id": integer,
    "fields":{
         key: value,...
    }
  }
}