Prewave Suppliers - Management API
Supplier management endpoints for listing, retrieving, updating supplier data, and bulk operations.
OpenAPI Specification
openapi: 3.0.1
info:
title: Public Prewave Actions Suppliers - Management API
description: 'Documentation of the Public Prewave API.
## What''s New
### Q1 2026 — Supplier Management, User Management, Actions and Feed
This quarter introduces major v2 upgrades, expanded administrative capabilities, and the new Actions API.
- **Core Releases:** Deployed Supplier Management API v2 and Feed API v2, alongside the all-new Actions API.
- **Enhanced Functionality:** Added robust identifier management, granular user and role configuration, and endpoints for managing supplier connection contacts.
- ⚠️ **Required Migration:** Legacy v1 endpoints for Suppliers and Sites Upsert have been deprecated. Developers must migrate existing integrations to v2 by **May 31, 2027** (original deadline was December 31, 2026).
📖 **[Read the Q1 2026 changelog](https://docs.prewave.com/en/articles/699847-q1-2026-public-api-updates)**
### Q2 2026 — Supplier Screening and External Scores
We have expanded our v2 documentation to include comprehensive integration guidance for supplier screening and validation workflows and identifier-based external score ingestion.
- **New Capabilities:** Added support for optional post-onboarding screening and validation during the create event.
- **External Scores:** Batch POST for multiple supplier sites, per-site history GET, and event-type discovery GET (`/public/v1/scores/externals` and `/public/v1/scores/externals/event-types`). Documented in OpenAPI when enabled for your organization.
- **Developer Resources:** Published new integration examples and detailed identifier validation rules to streamline your implementation process.
📖 **[Read the Q2 2026 changelog](https://docs.prewave.com/en/articles/699849-q2-2026-public-api-updates)**
### Q3 2026 — Scores Webhooks
To support event-driven architectures and eliminate the need for continuous API polling, we are introducing webhooks for score state changes later this year.
- **Event-Driven Architecture:** Register webhook URLs to receive real-time HTTP payloads whenever a supplier''s score updates, so you can drive immediate mitigation responses without polling the API.
- **Availability:** Comprehensive OpenAPI specifications and payload schemas will be published closer to the release date.
- **Note:** Schemas and behaviors are subject to refinement prior to general availability.
Documentation updates will be provided prior to release.
### Q4 2026 — Feed V2
We are enhancing Feed API v2 with additional capabilities on top of the existing `GET /public/v2/feed` contract (see Q1 changelog and OpenAPI for the current Feed v2 integration).
- **Availability:** Details will be announced before release.
- **Note:** Schemas and behaviors are subject to refinement prior to the official release.
Documentation updates will be provided prior to release.
---
## Authentication
Prewave’s public api uses *API tokens* to authenticate against our RESTful service. We’ll provide you an *API-token* that each
endpoint needs present as a http header.
To pass the token in a request, simply add it as a header-parameter with
* key = X-Auth-Token
* value = api-token
See an example in curl below where the api-token would be 12345678-90ab-cdef-1234-567890abcdef
```
curl --request GET \
--url https://REPLACE_WITH_SERVER/public/v1/target/prewave/3975230/alerts \
--header ''X-Auth-Token: 12345678-90ab-cdef-1234-567890abcdef''
```
---
## Manage API Tokens
Before you can obtain your API token, you''ll need the credentials for your API user. These credentials will be
sent to you as part of the company-onboarding. If you haven''t got your credentials yet, please reach out to
your sales-contact at Prewave or contact us via info@prewave.ai
To generate an API Token, navigate to https://www.prewave.com/management/api and log in with the
credentials of your API user. Then click at the button "Create New" and use your new api-token authentication as a header parameter.
You can create multiple API tokens and also remove existing API tokens on https://www.prewave.com/management/api.
API tokens do not expire, therefore you have to maintain the list of API tokens you are using manually.
---
## Default Rate Limits
We have two types of default rate limits. For increased access, please contact customer success.
| Type | Requests per 10 seconds | Requests per Minute |
|-----------------------------------|-------------------------|---------------------|
| GET requests | 100 | 500 |
| POST, PUT, PATCH, DELETE requests | 20 | 100 |
'
version: '1.0'
servers:
- url: https://api.prewave.com
description: Production Environment
security:
- Token authentication: []
tags:
- name: Suppliers - Management
description: Supplier management endpoints for listing, retrieving, updating supplier data, and bulk operations.
paths:
/public/v1/target/{systemId}/{targetId}/data:
put:
tags:
- Suppliers - Management
summary: Update target data.
description: "\nUpdate spend data and Code of Conduct status for the specified target.\n\n**Required Permission**: `update_supplier_data`\n "
operationId: updateEdgeData
parameters:
- name: systemId
in: path
description: The system ID is an identifier to determine from which the targetId might originate from. Supported systemIds are "prewave", "customer", "supplier", "own".
required: true
schema:
type: string
example: prewave
- name: targetId
in: path
description: The target ID can be the target's prewaveId or an external id (edge number) representing the site in another system.
required: true
schema:
type: string
example: 10422185
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PublicUpdateEdgeDataPayload'
required: true
responses:
'200':
description: Target data updated successfully. Returns the full updated target payload.
content:
application/json:
schema:
$ref: '#/components/schemas/PublicTargetDTO'
examples:
Updated target example:
summary: Target payload after a successful update
description: Updated target example
value: '{"id":102006215,"name":"Acme Manufacturing Inc","sname":"4990729","logo":"/images/company-img/acme-manufacturing-logo.svg","backgroundPicture":"/images/company-img/acme-manufacturing-bg.jpg","description":"Automotive parts manufacturer specializing in electric vehicle components and battery assemblies.","website":"https://www.acme-manufacturing.example.com","location":"Detroit, MI, US","yearFounded":1987,"size":"Large","screened":true,"screenedStatus":"Screened","linkedInId":"acme-manufacturing","type":{"id":5195261,"type":"organization","displayName":"Site Group","pluralName":"Site Groups","ordering":0,"scoring":"Alert"},"ctype":{"id":972417,"ctype":"company","targetTypeId":5195261,"displayName":"Site Group","pluralName":"Site Groups","icon":"fas fa-building","ordering":0,"priority":0,"connectable":true,"bgColor":"#E8F4FD","textColor":"#1A365D"},"geo":{"geometry":null,"properties":{"name":"Detroit","countryCode":"US","alertCount":null,"boundingBox":null},"type":"Feature"},"geoShape":{"geometry":null,"properties":{"name":null,"countryCode":null,"alertCount":null,"boundingBox":null},"type":"Feature"},"parents":[],"organization":{"id":987654321,"name":"Acme Corporation","sname":"6252001","logo":"/images/company-img/acme-corporation-logo.svg","backgroundPicture":"/images/company-img/acme-corporation-bg.jpg","description":"Global automotive supplier and parent organization of Acme Manufacturing Inc.","website":"https://www.acme-corporation.example.com","location":"Stuttgart, DE","yearFounded":1962,"size":"Very large","screened":true,"screenedStatus":"Screened","linkedInId":"acme-corporation","type":{"id":5195261,"type":"organization","displayName":"Site Group","pluralName":"Site Groups","ordering":0,"scoring":"Alert"},"ctype":{"id":972417,"ctype":"company","targetTypeId":5195261,"displayName":"Site Group","pluralName":"Site Groups","icon":"fas fa-building","ordering":0,"priority":0,"connectable":true,"bgColor":"#E8F4FD","textColor":"#1A365D"},"geo":{"geometry":null,"properties":{"name":"Stuttgart","countryCode":"DE","alertCount":null,"boundingBox":null},"type":"Feature"},"geoShape":{"geometry":null,"properties":{"name":null,"countryCode":null,"alertCount":null,"boundingBox":null},"type":"Feature"},"parents":[],"organization":null,"industries":[],"monitoredSince":{"date":"2018-01-10T09:00:00","_datetype_":"DateTime"},"earliestAlert":{"date":"2019-04-12T14:30:00","_datetype_":"DateTime"},"ordering":0,"disruptionStatusUpdate":null,"own":true,"managed":true,"isPublic":true,"connectionContactsCount":12,"population":null,"following":true,"collectionFollowing":true,"tier":null,"path":[],"collectionLevel":1,"collectionPath":[{"id":42,"name":"Tier-1 Suppliers"}],"collectionPaths":[[{"id":42,"name":"Tier-1 Suppliers"}]],"foreignSystems":[{"system":"customer","id":"ACME-CORP-001","source":"SAP"}],"scoreAvail":"Alert","revenue":8500000000,"impact":"Low","hsCode":[{"code":"870810","nshipments":128}],"merged_targets":[]},"industries":[{"id":554433221,"name":"Automotive Manufacturing","sname":null,"logo":null,"backgroundPicture":null,"description":"Industry classification for automotive parts and vehicle component manufacturing.","website":null,"location":"Global","yearFounded":null,"size":null,"screened":true,"screenedStatus":"Screened","linkedInId":null,"type":{"id":5195261,"type":"organization","displayName":"Site Group","pluralName":"Site Groups","ordering":0,"scoring":"Alert"},"ctype":{"id":1122334,"ctype":"industry","targetTypeId":5195261,"displayName":"Industry","pluralName":"Industries","icon":"fas fa-industry","ordering":10,"priority":1,"connectable":false,"bgColor":"#F0F0F0","textColor":"#333333"},"geo":{"geometry":null,"properties":{"name":null,"countryCode":null,"alertCount":null,"boundingBox":null},"type":"Feature"},"geoShape":{"geometry":null,"properties":{"name":null,"countryCode":null,"alertCount":null,"boundingBox":null},"type":"Feature"},"parents":[],"organization":null,"industries":[],"monitoredSince":null,"earliestAlert":null,"ordering":null,"disruptionStatusUpdate":null,"own":false,"managed":false,"isPublic":null,"connectionContactsCount":null,"population":null,"following":false,"collectionFollowing":false,"tier":null,"path":[],"collectionLevel":null,"collectionPath":[],"collectionPaths":[],"foreignSystems":[],"scoreAvail":"None","revenue":123.456,"impact":"Low","hsCode":[],"merged_targets":[]}],"monitoredSince":{"date":"2020-03-15T10:30:00","_datetype_":"DateTime"},"earliestAlert":{"date":"2021-06-01T08:00:00","_datetype_":"DateTime"},"ordering":1,"disruptionStatusUpdate":null,"own":true,"managed":true,"isPublic":false,"connectionContactsCount":3,"population":null,"following":true,"collectionFollowing":true,"tier":null,"path":[{"id":987654321,"name":"Acme Corporation","customName":null,"latestRequest":null,"foreignSystems":[{"number":"ACME-CORP-001","source":"SAP","existingEdgeId":null}]},{"id":102006215,"name":"Acme Manufacturing Inc","customName":null,"latestRequest":null,"foreignSystems":[{"number":"SUPPLIER001","source":"SAP","existingEdgeId":null}]}],"collectionLevel":2,"collectionPath":[{"id":42,"name":"Tier-1 Suppliers"},{"id":108,"name":"Automotive"}],"collectionPaths":[[{"id":42,"name":"Tier-1 Suppliers"},{"id":108,"name":"Automotive"}],[{"id":55,"name":"North America"},{"id":108,"name":"Automotive"}]],"foreignSystems":[{"system":"customer","id":"SUPPLIER001","source":"SAP"},{"system":"supplier","id":"ACME-MFG-42","source":"Excel"}],"scoreAvail":"Peer","revenue":1250000000,"impact":"Low","hsCode":[{"code":"870899","nshipments":42},{"code":"401110","nshipments":15}],"merged_targets":[102001100]}'
'404':
description: Target not found or no permission to access it.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
examples:
Target not found:
description: Target not found
value: '{"code":"resource_not_found","message":"Target not found: systemId=customer, targetId=INVALID_ID","solution":"Verify target ID and system ID are correct"}'
'403':
description: '403 Forbidden - Authentication or authorization failure. This status code is returned when: (1) the request lacks valid authentication credentials (missing or invalid X-Auth-Token header), or (2) the authenticated user does not have the required permission to access this resource.'
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedErrorDTO'
examples:
Access denied example:
summary: User lacks necessary permissions or authentication
value: "{\n \"loggedIn\": true,\n \"code\": \"access_denied\",\n \"message\": \"Access denied: you don't have necessary permissions to access this resource\",\n \"solution\": \"Contact support for appropriate permissions\"\n }"
'500':
description: 500 Internal Server Error - An unexpected error occurred on the server. The request may or may not have been processed.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
examples:
Error - Server Error:
summary: Unexpected server error
value: "{\n \"code\": \"internal_error\",\n \"message\": \"An unexpected error occurred\",\n \"solution\": \"Please try again later or contact support\"\n }"
'429':
description: '429 Too Many Requests - API rate limit exceeded. The request has been rejected because the rate limit for this endpoint has been exceeded. Default rate limits: GET requests - 100 per 10 seconds, 500 per minute; POST/PUT/PATCH/DELETE requests - 20 per 10 seconds, 100 per minute. For increased access, please contact customer success.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiRateLimitResponse'
examples:
Rate limit exceeded example:
summary: API rate limit exceeded
value: "{\n \"error\": \"API rate limit exceeded\",\n \"message\": \"You have reached the maximum allowed requests. Please try again later or upgrade your plan for increased access\",\n \"requestLimit\": 20,\n \"requestCount\": 20,\n \"limits\": [\n {\n \"requestLimit\": 20,\n \"timeInSeconds\": 10\n },\n {\n \"requestLimit\": 100,\n \"timeInSeconds\": 60\n }\n ],\n \"currentTime\": \"2026-01-15T10:30:00\",\n \"nextResetAt\": \"2026-01-15T10:30:10\"\n }"
/public/v1/target/targets/bulk-fetch:
post:
tags:
- Suppliers - Management
summary: Bulk fetch detailed target information by target IDs
description: 'Fetch detailed information for multiple targets at once, including name, supplier identifiers, and other target details.
This endpoint supports both Prewave internal target IDs and foreign system mappings for maximum flexibility.
**Required Permission**: `access_public_target`
**Performance impact**: Medium (depends on batch size)
**Use cases**:
- Get target details for multiple suppliers at once
- Resolve foreign system IDs to Prewave target information
- Bulk data synchronization and integration
**Request format**:
- Use `targetIds` for Prewave internal target IDs: `[101, 102, 103]`
- Use `foreignTargets` for foreign system mappings: `[{"systemId": "customer", "targetId": "SUPPLIER001"}]`
- Both fields are optional, but at least one must be provided
**Response format**:
- `targets`: Successfully fetched targets with full details (same as individual target endpoint)
- `errors`: Failed lookups with specific error reasons (NOT_FOUND, ACCESS_DENIED, etc.)
**Error handling**:
- Individual target errors are returned in the `errors` field, not as HTTP errors
- Empty results are valid (empty `targets` list)
- Permission checks are performed per target'
operationId: bulkFetchTargets
requestBody:
description: Request payload containing target IDs to fetch
content:
application/json:
schema:
$ref: '#/components/schemas/PublicBulkFetchTargetsRequest'
examples:
Internal IDs only:
summary: Fetch targets using Prewave internal IDs
description: Internal IDs only
value:
targetIds:
- 101
- 102
- 103
Foreign system mappings:
summary: Fetch targets using foreign system IDs
description: Foreign system mappings
value:
foreignTargets:
- systemId: customer
targetId: SUPPLIER001
- systemId: prewave
targetId: '12345'
Mixed request:
summary: Fetch targets using both internal and foreign IDs
description: Mixed request
value: '{"targetIds":[101,102,103],"foreignTargets":[{"systemId":"customer","targetId":"SUPPLIER001"},{"systemId":"prewave","targetId":"102006215"}],"isValid":true}'
required: true
responses:
'200':
description: Bulk fetch completed successfully. Check the response for successful targets and any errors.
content:
application/json:
schema:
$ref: '#/components/schemas/PublicBulkFetchTargetsResponse'
examples:
Successful response:
summary: Response with successful targets and errors
description: Successful response
value: '{"targets":[{"id":102006215,"name":"Acme Manufacturing Inc","sname":"4990729","logo":"/images/company-img/acme-manufacturing-logo.svg","backgroundPicture":"/images/company-img/acme-manufacturing-bg.jpg","description":"Automotive parts manufacturer specializing in electric vehicle components and battery assemblies.","website":"https://www.acme-manufacturing.example.com","location":"Detroit, MI, US","yearFounded":1987,"size":"Large","screened":true,"screenedStatus":"Screened","linkedInId":"acme-manufacturing","type":{"id":5195261,"type":"organization","displayName":"Site Group","pluralName":"Site Groups","ordering":0,"scoring":"Alert"},"ctype":{"id":972417,"ctype":"company","targetTypeId":5195261,"displayName":"Site Group","pluralName":"Site Groups","icon":"fas fa-building","ordering":0,"priority":0,"connectable":true,"bgColor":"#E8F4FD","textColor":"#1A365D"},"geo":{"geometry":null,"properties":{"name":"Detroit","countryCode":"US","alertCount":null,"boundingBox":null},"type":"Feature"},"geoShape":{"geometry":null,"properties":{"name":null,"countryCode":null,"alertCount":null,"boundingBox":null},"type":"Feature"},"parents":[],"organization":{"id":987654321,"name":"Acme Corporation","sname":"6252001","logo":"/images/company-img/acme-corporation-logo.svg","backgroundPicture":"/images/company-img/acme-corporation-bg.jpg","description":"Global automotive supplier and parent organization of Acme Manufacturing Inc.","website":"https://www.acme-corporation.example.com","location":"Stuttgart, DE","yearFounded":1962,"size":"Very large","screened":true,"screenedStatus":"Screened","linkedInId":"acme-corporation","type":{"id":5195261,"type":"organization","displayName":"Site Group","pluralName":"Site Groups","ordering":0,"scoring":"Alert"},"ctype":{"id":972417,"ctype":"company","targetTypeId":5195261,"displayName":"Site Group","pluralName":"Site Groups","icon":"fas fa-building","ordering":0,"priority":0,"connectable":true,"bgColor":"#E8F4FD","textColor":"#1A365D"},"geo":{"geometry":null,"properties":{"name":"Stuttgart","countryCode":"DE","alertCount":null,"boundingBox":null},"type":"Feature"},"geoShape":{"geometry":null,"properties":{"name":null,"countryCode":null,"alertCount":null,"boundingBox":null},"type":"Feature"},"parents":[],"organization":null,"industries":[],"monitoredSince":{"date":"2018-01-10T09:00:00","_datetype_":"DateTime"},"earliestAlert":{"date":"2019-04-12T14:30:00","_datetype_":"DateTime"},"ordering":0,"disruptionStatusUpdate":null,"own":true,"managed":true,"isPublic":true,"connectionContactsCount":12,"population":null,"following":true,"collectionFollowing":true,"tier":null,"path":[],"collectionLevel":1,"collectionPath":[{"id":42,"name":"Tier-1 Suppliers"}],"collectionPaths":[[{"id":42,"name":"Tier-1 Suppliers"}]],"foreignSystems":[{"system":"customer","id":"ACME-CORP-001","source":"SAP"}],"scoreAvail":"Alert","revenue":8500000000,"impact":"Low","hsCode":[{"code":"870810","nshipments":128}],"merged_targets":[]},"industries":[{"id":554433221,"name":"Automotive Manufacturing","sname":null,"logo":null,"backgroundPicture":null,"description":"Industry classification for automotive parts and vehicle component manufacturing.","website":null,"location":"Global","yearFounded":null,"size":null,"screened":true,"screenedStatus":"Screened","linkedInId":null,"type":{"id":5195261,"type":"organization","displayName":"Site Group","pluralName":"Site Groups","ordering":0,"scoring":"Alert"},"ctype":{"id":1122334,"ctype":"industry","targetTypeId":5195261,"displayName":"Industry","pluralName":"Industries","icon":"fas fa-industry","ordering":10,"priority":1,"connectable":false,"bgColor":"#F0F0F0","textColor":"#333333"},"geo":{"geometry":null,"properties":{"name":null,"countryCode":null,"alertCount":null,"boundingBox":null},"type":"Feature"},"geoShape":{"geometry":null,"properties":{"name":null,"countryCode":null,"alertCount":null,"boundingBox":null},"type":"Feature"},"parents":[],"organization":null,"industries":[],"monitoredSince":null,"earliestAlert":null,"ordering":null,"disruptionStatusUpdate":null,"own":false,"managed":false,"isPublic":null,"connectionContactsCount":null,"population":null,"following":false,"collectionFollowing":false,"tier":null,"path":[],"collectionLevel":null,"collectionPath":[],"collectionPaths":[],"foreignSystems":[],"scoreAvail":"None","revenue":123.456,"impact":"Low","hsCode":[],"merged_targets":[]}],"monitoredSince":{"date":"2020-03-15T10:30:00","_datetype_":"DateTime"},"earliestAlert":{"date":"2021-06-01T08:00:00","_datetype_":"DateTime"},"ordering":1,"disruptionStatusUpdate":null,"own":true,"managed":true,"isPublic":false,"connectionContactsCount":3,"population":null,"following":true,"collectionFollowing":true,"tier":null,"path":[{"id":987654321,"name":"Acme Corporation","customName":null,"latestRequest":null,"foreignSystems":[{"number":"ACME-CORP-001","source":"SAP","existingEdgeId":null}]},{"id":102006215,"name":"Acme Manufacturing Inc","customName":null,"latestRequest":null,"foreignSystems":[{"number":"SUPPLIER001","source":"SAP","existingEdgeId":null}]}],"collectionLevel":2,"collectionPath":[{"id":42,"name":"Tier-1 Suppliers"},{"id":108,"name":"Automotive"}],"collectionPaths":[[{"id":42,"name":"Tier-1 Suppliers"},{"id":108,"name":"Automotive"}],[{"id":55,"name":"North America"},{"id":108,"name":"Automotive"}]],"foreignSystems":[{"system":"customer","id":"SUPPLIER001","source":"SAP"},{"system":"supplier","id":"ACME-MFG-42","source":"Excel"}],"scoreAvail":"Peer","revenue":1250000000,"impact":"Low","hsCode":[{"code":"870899","nshipments":42},{"code":"401110","nshipments":15}],"merged_targets":[102001100]},{"id":101,"name":"Beta Components Ltd","sname":"2643743","logo":"/images/company-img/beta-components-logo.svg","backgroundPicture":null,"description":"Supplier of precision machined metal components.","website":"https://www.beta-components.example.com","location":"London, GB","yearFounded":2005,"size":"Medium","screened":true,"screenedStatus":"Pending","linkedInId":"beta-components","type":{"id":5195261,"type":"organization","displayName":"Site Group","pluralName":"Site Groups","ordering":0,"scoring":"Alert"},"ctype":{"id":972417,"ctype":"company","targetTypeId":5195261,"displayName":"Site Group","pluralName":"Site Groups","icon":"fas fa-building","ordering":0,"priority":0,"connectable":true,"bgColor":"#E8F4FD","textColor":"#1A365D"},"geo":{"geometry":null,"properties":{"name":"London","countryCode":"GB","alertCount":null,"boundingBox":null},"type":"Feature"},"geoShape":{"geometry":null,"properties":{"name":null,"countryCode":null,"alertCount":null,"boundingBox":null},"type":"Feature"},"parents":[],"organization":null,"industries":[],"monitoredSince":null,"earliestAlert":null,"ordering":null,"disruptionStatusUpdate":null,"own":false,"managed":false,"isPublic":false,"connectionContactsCount":1,"population":null,"following":false,"collectionFollowing":false,"tier":null,"path":[],"collectionLevel":null,"collectionPath":[],"collectionPaths":[],"foreignSystems":[{"system":"customer","id":"BETA-101","source":"SAP"}],"scoreAvail":"SSA","revenue":45000000,"impact":"Low","hsCode":[{"code":"732690","nshipments":8}],"merged_targets":[]}],"errors":[{"targetId":102,"systemId":null,"systemTargetId":null,"reason":"ACCESS_DENIED"},{"targetId":null,"systemId":"customer","systemTargetId":"UNKNOWN_SUPPLIER","reason":"NOT_FOUND"}]}'
'400':
description: Invalid request - neither targetIds nor foreignTargets provided
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
'403':
description: '403 Forbidden - Authentication or authorization failure. This status code is returned when: (1) the request lacks valid authentication credentials (missing or invalid X-Auth-Token header), or (2) the authenticated user does not have the required permission to access this resource.'
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedErrorDTO'
examples:
Access denied example:
summary: User lacks necessary permissions or authentication
value: "{\n \"loggedIn\": true,\n \"code\": \"access_denied\",\n \"message\": \"Access denied: you don't have necessary permissions to access this resource\",\n \"solution\": \"Contact support for appropriate permissions\"\n }"
'500':
description: 500 Internal Server Error - An unexpected error occurred on the server. The request may or may not have been processed.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDTO'
examples:
Error - Server Error:
summary: Unexpected server error
value: "{\n \"code\": \"internal_error\",\n \"message\": \"An unexpected error occurred\",\n \"solution\": \"Please try again later or contact support\"\n }"
'429':
description: '429 Too Many Requests - API rate limit exceeded. The request has been rejected because the rate limit for this endpoint has been exceeded. Default rate limits: GET requests - 100 per 10 seconds, 500 per minute; POST/PUT/PATCH/DELETE requests - 20 per 10 seconds, 100 per minute. For increased access, please contact customer success.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiRateLimitResponse'
examples:
Rate limit exceeded example:
summary: API rate limit exceeded
value: "{\n \"error\": \"API rate limit exceeded\",\n \"message\": \"You have reached the maximum allowed requests. Please try again later or upgrade your plan for increased access\",\n \"requestLimit\": 20,\n \"requestCount\": 20,\n \"limits\": [\n {\n \"requestLimit\": 20,\n \"timeInSeconds\": 10\n },\n {\n \"requestLimit\": 100,\n \"timeInSeconds\": 60\n }\n ],\n \"currentTime\": \"2026-01-15T10:30:00\",\n \"nextResetAt\": \"2026-01-15T10:30:10\"\n }"
/public/v1/target/{systemId}/{targetId}:
get:
tags:
- Suppliers - Management
summary: Get detailed information about a target.
description: "\nRetrieve detailed information about a target identified by system ID and target ID.\n\n**Required Permission**: `access_public_target`\n\n**Performance impact**: Low\n "
operationId: target
parameters:
- name: systemId
in: path
description: The system ID is an identifier to determine from which the targetId might originate from. Supported systemIds are "prewave", "customer", "supplier", "own".
required: true
schema:
type: string
example: prewave
- name: targetId
in: path
description: The target ID can be the target's prewaveId or an external id (edge number) representing the site in another system.
required: true
schema:
type: string
example: 10422185
responses:
'200':
description: Successfully retrieved target details
content:
application/json:
schema:
$ref: '#/components/schemas/PublicTargetDTO'
examples:
Target detail example:
summary: Sample target response with foreign system mappings
description: Target detail example
value: '{"id":102006215,"name":"Acme Manufacturing Inc","sname":"4990729","logo":"/images/company-img/acme-manufacturing-logo.svg","backgroundPicture":"/images/company-img/acme-manufacturing-bg.jpg","description":"Automotive parts manufacturer specializing in electric vehicle components and battery assemblies.","website":"https://www.acme-manufacturing.example.com","location":"Detroit, MI, US","yearFounded":1987,"size":"Large","screened":true,"screenedStatus":"Screened","linkedInId":"acme-manufacturing","type":{"id":5195261,"type":"organization","displayName":"Site Group","pluralName":"Site Groups","ordering":0,"scoring":"Alert"},"ctype":{"id":972417,"ctype":"company","targetTypeId":5195261,"displayName":"Site Group","pluralName":"Site Groups","icon":"fas fa-building","ordering":0,"priority":0,"connectable":true,"bgColor":"#E8F4FD","textColor":"#1A365D"},"geo":{"geometry":null,"properties":{"name":"Detroit","countryCode":"US","alertCount":null,"boundingBox":null},"type":"Feature"},"geoShape":{"geometry":null,"properties":{"name":null,"countryCode":null,"alertCount":null,"boundingBox":null},"type":"Feature"},"parents":[],"organization":{"id":987654321,"name":"Acme Corporation","sname":"6252001","logo":"/images/company-img/acme-corporation-logo.svg","backgroundPicture":"/images/company-img/acme-corporation-bg.jpg","description":"Global automotive supplier and parent organization of Acme Manufacturing Inc.","website":"https://www.acme-corporation.example.com","location":"Stuttgart, DE","yearFounded":1962,"size":"Very large","screened":true,"screenedStatus":"Screened","linkedInId":"acme-corporation","type":{"id":5195261,"type":"organization","displayName":"Site Group","pluralName":"Site Groups","ordering":0,"scoring":"Alert"},"ctype":{"id":972417,"ctype":"company","targetTypeId":5195261,"displayName":"Site Group","pluralName":"Site Groups","icon":"fas fa-building","ordering":0,"priority":0,"connectable":true,"bgColor":"#E8F4FD","textColor":"#1A365D"},"geo":{"geometry":null,"properties":{"name":"Stuttgart","countryCode":"DE","alertCount
# --- truncated at 32 KB (124 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/prewave/refs/heads/main/openapi/prewave-suppliers-management-api-openapi.yml