DEVELOPER DOCS

Build on the GCC's spare parts inquiry platform

REST API, real-time webhooks, and a machine-readable OpenAPI spec. Integrate RFQ creation, bid submission, and supplier discovery into any ERP or procurement system.

fetch-rfqs.js

const response = await fetch(`https://partsbid.io/api/v1/rfqs?status=open`, {

headers: {

"Authorization": `Bearer ${apiKey}`

}

});

const { data, nextCursor } = await response.json();

// Returns open RFQs with cursor pagination

GET STARTED

Three ways to integrate

Whether you're connecting a full ERP system or building a lightweight integration, start with the approach that fits.

REST API

15 endpoints covering RFQs, bids, suppliers, and webhook management. Bearer token auth, cursor pagination, SAR-native pricing.

Read API reference →

Webhooks

Real-time push events for every RFQ lifecycle stage. HMAC-SHA256 signed payloads, automatic retry with exponential backoff, delivery logs included.

Set up webhooks →

OpenAPI spec

Machine-readable OpenAPI 3.0 spec at /openapi.json. Import directly into Postman, Insomnia, or your ERP vendor's API client.

Download spec →

ENDPOINTS

API reference — v1

All endpoints require a valid API key via Authorization: Bearer header.

Base URL: https://partsbid.io/api/v1

RFQ & Bid endpointsrfq:read · rfq:write · bid:read · bid:write

GET/rfqsList open RFQs · category, region, cursor filtersrfq:read

POST/rfqsCreate RFQ · triggers rfq.created webhookrfq:write

GET/rfqs/:idSingle RFQ with parts line itemsrfq:read

POST/rfqs/:id/bidsSubmit bid · supplier accounts onlybid:write

GET/rfqs/:id/bidsList bids · buyers see all, suppliers see ownbid:read

Supplier & Webhook endpointssupplier:read · webhook:read · webhook:write

GET/suppliersDirectory search · category, region, verified filtersupplier:read

GET/suppliers/:idSupplier profile and active categoriessupplier:read

POST/webhooksRegister endpoint · secret returned once onlywebhook:write

GET/webhooksList your webhook endpointswebhook:read

DELETE/webhooks/:idDeactivate an endpointwebhook:write

GET/webhooks/:id/deliveriesLast 50 delivery attempts with statuswebhook:read

POST/webhooks/:id/testSend test ping to endpoint URLwebhook:write

Error response format

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Missing required scope: bid:write",
    "details": {}
  }
}

AUTHENTICATION

API keys

Generate keys from your supplier or buyer dashboard. Apply scopes at creation time using the principle of least privilege.

Authorization header

Authorization: Bearer pb_live_a3f9c2...

Keys are prefixed pb_live_ followed by 64 hex chars. The raw key is shown once at creation — store it in your environment variables immediately.

rfq:readrfq:writebid:readbid:writesupplier:readwebhook:readwebhook:write

WEBHOOKS

Live events

Subscribe once. Receive push notifications for every stage of the RFQ lifecycle directly into your system.

Event catalogueHMAC-SHA256 signed

rfq.createdNew RFQ published by a buyer

rfq.bid_receivedA supplier submitted a bid

rfq.bid_acceptedBuyer awarded a bid to a supplier

rfq.expiredRFQ closed with no bids accepted

supplier.verifiedSupplier passed platform verification

{
  "event": "rfq.bid_received",
  "timestamp": "2026-04-04T10:23:00Z",
  "data": {
    "rfqId": "rfq_x9k2m...",
    "bidId": "bid_7p3n...",
    "supplierName": "Al-Manahil Trading",
    "price": 2450.00,
    "currency": "SAR"
  }
}

Verify the X-PartsBid-Signature header using HMAC-SHA256 before processing any webhook payload.

Rate limits

100 requests per minute per API key, enforced with a sliding window. Exceeded requests return HTTP 429 with a Retry-After header.

Plan	Limit
Starter	100 req/min
Professional	100 req/min
Enterprise	Contact us

Cursor pagination

All list endpoints use cursor-based pagination, not page numbers. Pass the returned nextCursor as the cursor query param in your next request.

GET /api/v1/rfqs?limit=20&cursor=eyJpZCI6ImN...

Response:
{
  "data": [...],
  "nextCursor": "eyJpZCI6Im..."
}

CHANGELOG

What's new

April 2026Launch

Public API v1 — general availability

15 endpoints covering RFQs, bids, suppliers, and webhooks. OpenAPI 3.0 spec available at /openapi.json. HMAC-signed webhook delivery with exponential retry.

April 2026Launch

AI Platform Connector (MCP)

Connect AI assistants like Claude directly to PartsBid. 7 tools: search suppliers, search parts, create RFQs, check RFQ status, list bids, compare bids, and get supplier profiles — all from your AI assistant. Enterprise plan required.

// Claude Desktop: ~/.claude/claude_desktop_config.json
{
  "mcpServers": {
    "partsbid": {
      "url": "https://partsbid.io/api/mcp",
      "headers": {
        "Authorization": "Bearer pb_live_YOUR_KEY"
      }
    }
  }
}

Coming soonPlanned

JavaScript SDK

A typed npm package wrapping the v1 API. Includes webhook signature verification helpers.

Coming soonPlanned

ERP connector guides

Step-by-step integration guides for SAP, Oracle, and Odoo. Community contributed.

Ready to integrate?

Generate your API key from your dashboard. Import the OpenAPI spec into Postman and you're making calls in minutes.

Download openapi.json Get API key →

DEVELOPER DOCS

Build on the GCC's spare parts inquiry platform

REST API, real-time webhooks, and a machine-readable OpenAPI spec. Integrate RFQ creation, bid submission, and supplier discovery into any ERP or procurement system.

fetch-rfqs.js

const response = await fetch(`https://partsbid.io/api/v1/rfqs?status=open`, {

headers: {

"Authorization": `Bearer ${apiKey}`

}

});

const { data, nextCursor } = await response.json();

// Returns open RFQs with cursor pagination

GET STARTED

Three ways to integrate

Whether you're connecting a full ERP system or building a lightweight integration, start with the approach that fits.

REST API

15 endpoints covering RFQs, bids, suppliers, and webhook management. Bearer token auth, cursor pagination, SAR-native pricing.

Read API reference →

Webhooks

Real-time push events for every RFQ lifecycle stage. HMAC-SHA256 signed payloads, automatic retry with exponential backoff, delivery logs included.

Set up webhooks →

OpenAPI spec

Machine-readable OpenAPI 3.0 spec at /openapi.json. Import directly into Postman, Insomnia, or your ERP vendor's API client.

Download spec →

ENDPOINTS

API reference — v1

All endpoints require a valid API key via Authorization: Bearer header.

Base URL: https://partsbid.io/api/v1

RFQ & Bid endpointsrfq:read · rfq:write · bid:read · bid:write

GET/rfqsList open RFQs · category, region, cursor filtersrfq:read

POST/rfqsCreate RFQ · triggers rfq.created webhookrfq:write

GET/rfqs/:idSingle RFQ with parts line itemsrfq:read

POST/rfqs/:id/bidsSubmit bid · supplier accounts onlybid:write

GET/rfqs/:id/bidsList bids · buyers see all, suppliers see ownbid:read

Supplier & Webhook endpointssupplier:read · webhook:read · webhook:write

GET/suppliersDirectory search · category, region, verified filtersupplier:read

GET/suppliers/:idSupplier profile and active categoriessupplier:read

POST/webhooksRegister endpoint · secret returned once onlywebhook:write

GET/webhooksList your webhook endpointswebhook:read

DELETE/webhooks/:idDeactivate an endpointwebhook:write

GET/webhooks/:id/deliveriesLast 50 delivery attempts with statuswebhook:read

POST/webhooks/:id/testSend test ping to endpoint URLwebhook:write

Error response format

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Missing required scope: bid:write",
    "details": {}
  }
}

AUTHENTICATION

API keys

Generate keys from your supplier or buyer dashboard. Apply scopes at creation time using the principle of least privilege.

Authorization header

Authorization: Bearer pb_live_a3f9c2...

Keys are prefixed pb_live_ followed by 64 hex chars. The raw key is shown once at creation — store it in your environment variables immediately.

rfq:readrfq:writebid:readbid:writesupplier:readwebhook:readwebhook:write

WEBHOOKS

Live events

Subscribe once. Receive push notifications for every stage of the RFQ lifecycle directly into your system.

Event catalogueHMAC-SHA256 signed

rfq.createdNew RFQ published by a buyer

rfq.bid_receivedA supplier submitted a bid

rfq.bid_acceptedBuyer awarded a bid to a supplier

rfq.expiredRFQ closed with no bids accepted

supplier.verifiedSupplier passed platform verification

{
  "event": "rfq.bid_received",
  "timestamp": "2026-04-04T10:23:00Z",
  "data": {
    "rfqId": "rfq_x9k2m...",
    "bidId": "bid_7p3n...",
    "supplierName": "Al-Manahil Trading",
    "price": 2450.00,
    "currency": "SAR"
  }
}

Verify the X-PartsBid-Signature header using HMAC-SHA256 before processing any webhook payload.

Rate limits

100 requests per minute per API key, enforced with a sliding window. Exceeded requests return HTTP 429 with a Retry-After header.

Plan	Limit
Starter	100 req/min
Professional	100 req/min
Enterprise	Contact us

Cursor pagination

All list endpoints use cursor-based pagination, not page numbers. Pass the returned nextCursor as the cursor query param in your next request.

GET /api/v1/rfqs?limit=20&cursor=eyJpZCI6ImN...

Response:
{
  "data": [...],
  "nextCursor": "eyJpZCI6Im..."
}

CHANGELOG

What's new

April 2026Launch

Public API v1 — general availability

15 endpoints covering RFQs, bids, suppliers, and webhooks. OpenAPI 3.0 spec available at /openapi.json. HMAC-signed webhook delivery with exponential retry.

April 2026Launch

AI Platform Connector (MCP)

// Claude Desktop: ~/.claude/claude_desktop_config.json
{
  "mcpServers": {
    "partsbid": {
      "url": "https://partsbid.io/api/mcp",
      "headers": {
        "Authorization": "Bearer pb_live_YOUR_KEY"
      }
    }
  }
}

Coming soonPlanned

JavaScript SDK

A typed npm package wrapping the v1 API. Includes webhook signature verification helpers.

Coming soonPlanned

ERP connector guides

Step-by-step integration guides for SAP, Oracle, and Odoo. Community contributed.

Ready to integrate?

Generate your API key from your dashboard. Import the OpenAPI spec into Postman and you're making calls in minutes.

Download openapi.json Get API key →