GET Supplier Addresses

Retrieve a paginated list of addresses for a supplier.

Endpoint

Endpoint

/api/suppliers/{supplierId}/addresses

Method

GET

Scope

riskassess.supplier.read

Headers

Header Argument

Authorization

Bearer token

Accept

application/json or application/xml

X-Correlation-Id

(Optional) Request tracing ID

Parameters

Table 1. Path parameters
Parameter Description

supplierId

Supplier entityId (GUID). Empty GUID returns HTTP 400 BadRequest (no JSON envelope).
Table 2. Query parameters
Parameter Required Description

limit

No

Page size. Default: 50.

offset

No

Rows to skip. Default: 0.

order_by

No

(Optional) Sort field. Sortable fields: createdAt, modifiedAt.

dir

No

Sort direction: Asc or Desc. Default: Asc.

includeDeleted

No

Include soft-deleted addresses when true. Default: false.
Table 3. Filterable fields
API field Filter Sort (order_by)

entityId

Yes

No

type

Yes

No

status

Yes

No

streetAddress1, streetAddress2, streetAddress3, streetAddress4

Yes

No

city, state, postalCode, county, country

Yes

No

siteNumber, externalReference, siteDunnsNumber

Yes

No

createdAt

Yes

Yes

modifiedAt

Yes

Yes

Get supplier addresses

Endpoint

GET /api/suppliers/{supplierId}/addresses

Example cURL request
curl --location 'https://<your-instance>.risk.com/api/suppliers/8ceb6513-52fa-487e-bda8-176e074a9371/addresses?limit=10&offset=0' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ••••••'
Example response
{
    "success": true,
    "result": {
        "totalCount": 1,
        "addresses": [
            {
                "entityId": "a4a78d63-b131-42c5-867b-0094ce27fc1c",
                "name": "Penn Center West",
                "status": "",
                "type": "Headquarters",
                "streetAddress1": "4 Penn Center West",
                "streetAddress2": "Suite 326",
                "streetAddress3": "",
                "streetAddress4": "",
                "city": "Pittsburgh",
                "state": "PA",
                "postalCode": "15276",
                "county": "",
                "country": "US",
                "createdAt": "2023-05-22T09:28:03.667Z",
                "modifiedAt": "2023-05-22T09:28:03.667Z"
            }
        ]
    },
    "errors": []
}
Example error response
{
    "success": false,
    "result": null,
    "errors": [
        {
            "message": "Supplier Not Found",
            "errorCode": "DataNotFound"
        }
    ]
}