The Retrieve Suppliers API is used by the Agent to access a comprehensive list of all connected suppliers. By using this API, the Agent can obtain key details about each supplier, including unique identifiers, contact information, and their current connectivity status. The API response provides a clear and structured overview of all connected suppliers, making it easier for the Agent to manage and interact with them.
Method Endpoint Description GET v2023.07.31/suppliers Retrieve a list of all connected suppliers
Parameters Required / Optional Description Data Type page Optional The page to be shown int pageSize Optional Limits the number of returned results int
Response Item Description Data Type "suppliers"An array containing information about the connected Suppliers array
Response Item Description Data Type "user_id"The unique identifier of the Supplier int "email"The email address associated with the supplier user string "telephone"The contact telephone number of the supplier string "full_name"The full name of the Supplier string "first_name"The first name of the Supplier string "last_name"The last name of the Supplier string "company_name"The name of the company associated with the Supplier string "address"An object containing the address details of the Supplier object "domain_name"The domain name associated with the supplier's website string
Response Item Description Data Type "address_line_1"The first line of the Supplier's address string "address_line_2"The second line of the Supplier's address (optional) string "city"The City where the Supplier is located string "state_province"The State or Province where the Supplier is located string "country"The Country where the Supplier is located string "postal_code"The Postal or ZIP code of the Supplier's location string
cURL
curl --request GET \
--url 'https://api.ciiruspartners.com/v2023.07.31/suppliers?page=1&pageSize=50'JSON
{
"suppliers": [
{
"user_id": 42330,
"email": "[email protected] ",
"telephone": "3212518020",
"full_name": "CiiRUS VRS",
"first_name": "CiiRUS",
"last_name": "VRS",
"company_name": "CiiRUS,Inc.",
"address": {
"address_line_1": "1142 Celebration Blvd",
"address_line_2": "",
"city": "Celebration",
"state_province": "FL",
"country": "US",
"postal_code": "34747"
},
"domain_name": "https://ciirus.com"
},
...
],
"next_page_url": "https://api.ciiruspartners.com/v20230731/suppliers?page=2&pageSize=50",
"total_page_count": 4
} 