What can we help you find? Products Total Spend Management Platform Integration Technical Documentation Risk Assess Integrations Risk Assess REST API GET Suppliers

GET Suppliers

Retrieve a list of suppliers belonging to the tenant.

Endpoint

Endpoint	`/api/suppliers`
Method	GET

Headers

Header	Argument
Authorization	Bearer token
Accept	application/json or application/xml

Parameters

Table 1. Query parameters
Paremeter	Description
limit	(Optional) Maximum number of items in the response. Default: 50.
offset	(Optional) Number of items to skip from the start. Default: 0.
status	(Optional) Supplier status. For example: Active, Inactive.
sourceSystem	(Optional) Filter by source system.

Get suppliers

Endpoint

GET /api/suppliers

Example cURL request

curl --location 'https://<your-instance>.risk.com/api/suppliers' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••'

Example response

{
    "result": {
        "totalCount": 1,
        "suppliers": [
            {
                "entityId": "8df17abd-1ce4-47dd-96a9-03c310ddd230",
                "name": "Auto_BulkUpload_BE_05032023234658_T2",
                "supplierNumber": "392",
                "status": "General_Active",
                "createdAt": "2023-08-29T17:36:04.303Z",
                "modifiedAt": "2023-08-29T18:17:07.363Z",
                "sourceId": null,
                "sourceObjectType": null,
                "sourceSystem": null
            }
        ]
    },
    "errors": [],
    "success": true
}