Skip to main content
List all opportunities for a client
curl --request GET \
  --url https://api.rampartcorporation.com/v2/opportunity \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-id: <x-client-id>'
{
  "spendAnalyzed": 500000,
  "savingsFound": 75000,
  "savingsPercentage": 15,
  "opportunities": [
    {
      "id": "123-456-789",
      "category": "MRO",
      "sourceVendor": {
        "name": "Fastenal",
        "domain": "fastenal.com"
      },
      "annualSpend": 132196,
      "targetVendor": {
        "name": "Grainger",
        "domain": "grainger.com"
      },
      "annualSavings": {
        "amount": 19168,
        "percentage": 14.5
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>.

Headers

​
x-client-id
string
required

Client ID for authentication

Response

200 - application/json

Successfully retrieved opportunities summary with aggregated data

​
spendAnalyzed
number

Total amount of spend analyzed

Example:

500000

​
savingsFound
number

Total potential savings found

Example:

75000

​
savingsPercentage
number

Overall savings percentage

Example:

15

​
opportunities
object[]

List of individual opportunities