Retraced Companies API
The Companies API from Retraced — 3 operation(s) for companies.
OpenAPI Specification
openapi: 3.0.3
info:
title: Public API Reference Certificates Companies API
description: 'The retraced API comprises all publicly enabled options to make
machine-to-machine changes in the retraced platform. The retraced dashboard uses the
same endpoints, but also in addition more. If you wish to use the API of the dashboard,
it is possible but not versioned cleanly like the public API.
## Authentication
The authentication procedure is passwordless and uses an API key in the header. To get
an API key log into the Retraced Platform and navigate to **Developers HQ > API Keys**
then click **Create**. Be sure to copy the key somewhere safe, as you won''t be able to
view it again. If you don''t see Developers HQ in the sidebar contact your Customer
Success Manager to enable this for you. You can now set the key directly in request
headers. To authenticate using an API key, set the header key `companyapikey` to the
value of your API key.
## Getting Started
Retraced has 2 environments against which you can send your requests and receive the
expected response: staging (for development and testing) and production. Your API key
is scoped for both environments. The staging Base URL is
https://publicapi.staging.retraced.com. Staging copies production data once daily, and
all changes made on staging will be deleted.
Find detailed guides on how to use the endpoints and how we recommend building an
integration given your use case in our
[guides](https://publicapi.retraced.com/api/v2/guides). A history of public API
changes is available in the
[release notes](https://publicapi.retraced.com/api/v2/release-notes).'
version: 2.938.1
servers: []
tags:
- name: Companies
paths:
/api/v2/companies/:
get:
tags:
- Companies
description: List companies in your network
parameters:
- schema:
type: integer
minimum: 1
maximum: 500
in: query
name: limit
required: false
- schema:
type: integer
minimum: 1
maximum: 9007199254740991
in: query
name: page
required: false
- schema:
default: desc
type: string
enum:
- asc
- desc
- ASC
- DESC
in: query
name: order
required: false
- schema:
default: name
type: string
enum:
- name
- createdAt
- updatedAt
in: query
name: sort
required: false
- schema:
type: string
maxLength: 512
in: query
name: filter
required: false
- schema:
default: 'false'
anyOf:
- type: string
- type: boolean
in: query
name: isSupplierNetwork
required: false
- schema:
type: string
in: query
name: companyIds
required: false
- schema:
type: string
in: query
name: excludeCompanyIds
required: false
- schema:
type: string
in: query
name: findSimilar
required: false
- schema:
type: string
in: query
name: name
required: false
- schema:
default: 'false'
anyOf:
- type: string
- type: boolean
in: query
name: includeOwnCompany
required: false
- schema:
default: 'false'
anyOf:
- type: string
- type: boolean
in: query
name: isDropDown
required: false
- schema:
type: string
in: query
name: hasFeature
required: false
- schema:
default: 'false'
anyOf:
- type: string
- type: boolean
in: query
name: hasGeojson
required: false
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
metadata:
type: object
properties:
success:
default: true
type: boolean
pagination:
type: object
properties:
page:
default: 1
type: number
limit:
default: 10
type: number
total:
default: 0
type: number
totalPages:
default: 0
type: number
required:
- page
- limit
- total
- totalPages
additionalProperties: false
required:
- success
additionalProperties: false
data:
type: array
items:
type: object
properties:
id:
type: string
officialName:
anyOf:
- type: string
- type: 'null'
name:
type: string
updatedAt:
anyOf:
- type: string
- type: 'null'
key:
type: string
byCompanyId:
type: string
onBehalfOfCompanyId:
type: string
profileType:
type: string
count:
type: number
creationDate:
anyOf:
- type: string
- type: 'null'
connectionDate:
anyOf:
- type: string
- type: 'null'
createdAt:
anyOf:
- type: string
- type: 'null'
createdByImpersonateId:
anyOf:
- type: string
- type: 'null'
createdByUserId:
anyOf:
- type: string
- type: 'null'
createdByCompanyId:
anyOf:
- type: string
- type: 'null'
createdByApiKeyId:
anyOf:
- type: string
- type: 'null'
updatedByImpersonateId:
anyOf:
- type: string
- type: 'null'
updatedByUserId:
anyOf:
- type: string
- type: 'null'
updatedByCompanyId:
anyOf:
- type: string
- type: 'null'
updatedByApiKeyId:
anyOf:
- type: string
- type: 'null'
facilityProcesses:
anyOf:
- type: string
- type: 'null'
relationshipType:
anyOf:
- type: array
items:
type: object
properties:
id:
type: string
key:
type: string
text:
type: string
required:
- id
additionalProperties: false
- type: 'null'
imageList:
anyOf:
- type: array
items:
anyOf:
- type: object
properties:
id:
type: string
url:
type: string
fileType:
type: string
required:
- id
- url
additionalProperties: false
- type: 'null'
- type: 'null'
connectionType:
anyOf:
- type: string
- type: 'null'
supplyChainTier:
anyOf:
- type: array
items:
type: string
- type: 'null'
responsiblePerson:
anyOf:
- type: array
items:
type: object
properties:
id:
type: string
key:
type: string
text:
type: string
required:
- id
additionalProperties: false
- type: 'null'
vendors:
anyOf:
- type: array
items:
type: object
properties:
id:
type: string
key:
type: string
text:
type: string
required:
- id
additionalProperties: false
- type: 'null'
agents:
anyOf:
- type: array
items:
type: object
properties:
id:
type: string
key:
type: string
text:
type: string
required:
- id
additionalProperties: false
- type: 'null'
geojson:
anyOf:
- type: string
- type: 'null'
displayName:
anyOf:
- type: string
- type: 'null'
transliteratedDisplayName:
anyOf:
- type: string
- type: 'null'
transliteratedOfficialName:
anyOf:
- type: string
- type: 'null'
description:
anyOf:
- type: string
- type: 'null'
country:
anyOf:
- type: string
- type: 'null'
countryName:
anyOf:
- type: string
- type: 'null'
addressLine1:
anyOf:
- type: string
- type: 'null'
addressLine2:
anyOf:
- type: string
- type: 'null'
county:
anyOf:
- type: string
- type: 'null'
zipCode:
anyOf:
- type: string
- type: 'null'
website:
anyOf:
- type: string
- type: 'null'
phone:
anyOf:
- type: string
- type: 'null'
facEmail:
anyOf:
- type: string
- type: 'null'
companySize:
anyOf:
- type: string
- type: 'null'
companyType:
anyOf:
- type: string
- type: 'null'
founded:
anyOf:
- type: string
- type: 'null'
videoFile:
anyOf:
- type: string
- type: 'null'
collaborationStatus:
anyOf:
- type: string
- type: 'null'
collaborationStartDate:
anyOf:
- type: string
- type: 'null'
retracedRiskScore:
anyOf:
- type: string
- type: 'null'
city:
anyOf:
- type: string
- type: 'null'
collaborationEndDate:
anyOf:
- type: string
- type: 'null'
internalCompanyCode:
anyOf:
- type: string
- type: 'null'
totalUsersCount:
type: number
activeUsersCount:
type: number
invitedUsersCount:
type: number
featuredImageFileUrl:
anyOf:
- type: string
- type: 'null'
originalFeaturedImageFileUrl:
anyOf:
- type: string
- type: 'null'
originalVideoFileUrl:
anyOf:
- type: string
- type: 'null'
connectionTypeId:
anyOf:
- type: string
- type: 'null'
required:
- id
- officialName
- name
- updatedAt
- key
- byCompanyId
- onBehalfOfCompanyId
- profileType
- creationDate
- connectionDate
- createdAt
- createdByImpersonateId
- createdByUserId
- createdByCompanyId
- createdByApiKeyId
- updatedByImpersonateId
- updatedByUserId
- updatedByCompanyId
- updatedByApiKeyId
- facilityProcesses
- relationshipType
- imageList
- connectionType
- supplyChainTier
- responsiblePerson
- vendors
- agents
- geojson
- displayName
- transliteratedDisplayName
- transliteratedOfficialName
- description
- country
- countryName
- addressLine1
- addressLine2
- county
- zipCode
- website
- phone
- facEmail
- companySize
- companyType
- founded
- videoFile
- collaborationStatus
- collaborationStartDate
- city
- collaborationEndDate
- internalCompanyCode
- totalUsersCount
- activeUsersCount
- invitedUsersCount
- originalVideoFileUrl
- connectionTypeId
additionalProperties: false
required:
- metadata
- data
additionalProperties: false
example:
metadata:
success: true
pagination:
page: 1
limit: 2
total: 101
totalPages: 51
data:
- id: LD1FQKPIB89
officialName: Zipper Demo Company
name: Zipper Demo Company
updatedAt: '2026-06-11T06:43:02.905Z'
key: LD1FQKPIB89
byCompanyId: M4MRIN4A9JQ
onBehalfOfCompanyId: M4MRIN4A9JQ
profileType: ABOUT
count: 101
creationDate: '2022-05-13T08:26:11.286Z'
connectionDate: '2022-05-13T08:26:11.286Z'
createdAt: '2022-05-13T08:26:11.286Z'
createdByImpersonateId: HM9TRNB5MQ7
createdByUserId: GZXUI1P6Q24
createdByCompanyId: M4MRIN4A9JQ
createdByApiKeyId: null
updatedByImpersonateId: null
updatedByUserId: IXKEIR4YEYF
updatedByCompanyId: M4MRIN4A9JQ
updatedByApiKeyId: null
facilityProcesses: ZIPPER_SUPPLIER
relationshipType:
- id: MV2LA4RK6EKCH5IASD
imageList:
- id: MTZK7H1Q5J4PG3GXK2
url: https://retraced-bucket-production-public.imgix.net/MTZK7H1Q5J4PG3GXK2.png
fileType: IMAGE
connectionType: SUPPLIER
supplyChainTier: null
responsiblePerson: null
vendors: null
agents: null
geojson: '{"type": "Feature", "geometry": {"type": "Point", "coordinates": [9.502744, 40.923266]}}'
displayName: Zipper Demo Company
transliteratedDisplayName: null
transliteratedOfficialName: null
description: Zipper Demo Company was founded in Olbia in 1934 and can be found in 90 companies in over 60 counties/regions with over 42,000 employees globally.
country: IT
countryName: Italy
addressLine1: null
addressLine2: null
county: null
zipCode: '07026'
website: null
phone: null
facEmail: null
companySize: FROM_10001_TO_INFINITE
companyType: null
founded: null
videoFile: null
collaborationStatus: AA92A7ZX519I2DPQSU
collaborationStartDate: null
retracedRiskScore: '2.31'
city: Olbia
collaborationEndDate: null
internalCompanyCode: null
totalUsersCount: 0
activeUsersCount: 0
invitedUsersCount: 0
featuredImageFileUrl: https://retraced-bucket-production-public.imgix.net/MTZK7H1Q5J4PG3GXK2.png
originalVideoFileUrl: null
connectionTypeId: M4MRIN4A9JQ
- id: 9VAK4RL9RJX
officialName: Zhejiang Thermal Drinkware Co., Ltd.
name: Zhejiang Thermal Drinkware Co., Ltd.
updatedAt: '2026-06-11T06:43:03.797Z'
key: 9VAK4RL9RJX
byCompanyId: M4MRIN4A9JQ
onBehalfOfCompanyId: M4MRIN4A9JQ
profileType: ABOUT
count: 101
creationDate: '2026-02-27T08:10:08.090Z'
connectionDate: '2026-02-27T08:10:08.090Z'
createdAt: '2026-02-27T08:10:08.090Z'
createdByImpersonateId: null
createdByUserId: 1MZFVJVYR63
createdByCompanyId: M4MRIN4A9JQ
createdByApiKeyId: null
updatedByImpersonateId: null
updatedByUserId: IXKEIR4YEYF
updatedByCompanyId: M4MRIN4A9JQ
updatedByApiKeyId: null
facilityProcesses: ASSEMBLY
relationshipType: null
imageList:
- id: file_JMKNZB1795XQ6
url: https://retraced-bucket-production-public.imgix.net/file_JMKNZB1795XQ6.png
fileType: IMAGE
connectionType: SUPPLIER
supplyChainTier: null
responsiblePerson: null
vendors: null
agents: null
geojson: '{"type": "Feature", "geometry": {"type": "Point", "coordinates": [105, 35]}}'
displayName: Zhejiang Thermal Drinkware Co., Ltd.
transliteratedDisplayName: null
transliteratedOfficialName: null
description: null
country: CN
countryName: China
addressLine1: null
addressLine2: null
county: null
zipCode: null
website: null
phone: null
facEmail: null
companySize: null
companyType: null
founded: null
videoFile: null
collaborationStatus: null
collaborationStartDate: null
retracedRiskScore: '3.53'
city: null
collaborationEndDate: null
internalCompanyCode: null
totalUsersCount: 0
activeUsersCount: 0
invitedUsersCount: 0
featuredImageFileUrl: https://retraced-bucket-production-public.imgix.net/file_JMKNZB1795XQ6.png
originalVideoFileUrl: null
connectionTypeId: M4MRIN4A9JQ
/api/v2/companies/{id}:
get:
tags:
- Companies
description: Get company profile by ID. Type can be ABOUT, OTHER_IDS, or OPERATIONAL_METRICS.
parameters:
- schema:
default: ABOUT
type: string
enum:
- ABOUT
- OTHER_IDS
- OPERATIONAL_METRICS
in: query
name: type
required: false
- schema:
type: string
minLength: 1
in: path
name: id
required: true
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
metadata:
type: object
properties:
success:
default: true
type: boolean
required:
- success
additionalProperties: false
data:
type: object
properties:
forCompanyId:
type: string
byCompanyId:
type: string
onBehalfOfCompanyId:
type: string
profileType:
type: string
data:
type: object
additionalProperties: {}
isConnected:
type: boolean
isReverseConnected:
type: boolean
createdAt:
anyOf:
- type: string
- type: 'null'
createdByImpersonateId:
anyOf:
- type: string
- type: 'null'
createdByUserId:
anyOf:
- type: string
- type: 'null'
createdByCompanyId:
anyOf:
- type: string
- type: 'null'
createdByApiKeyId:
anyOf:
- type: string
- type: 'null'
createdByApiKeyLabel:
anyOf:
- type: string
- type: 'null'
updatedAt:
anyOf:
- type: string
- type: 'null'
updatedByImpersonateId:
anyOf:
- type: string
- type: 'null'
updatedByUserId:
anyOf:
- type: string
- type: 'null'
updatedByCompanyId:
anyOf:
- type: string
- type: 'null'
updatedByApiKeyId:
anyOf:
- type: string
- type: 'null'
updatedByApiKeyLabel:
anyOf:
- type: string
- type: 'null'
templateCompletionPercentage:
type: number
required:
- forCompanyId
- byCompanyId
- onBehalfOfCompanyId
- profileType
- data
- isConnected
- isReverseConnected
additionalProperties: false
required:
- metadata
- data
additionalProperties: false
example:
metadata:
success: true
data:
forCompanyId: DZLSG27839B
byCompanyId: M4MRIN4A9JQ
onBehalfOfCompanyId: M4MRIN4A9JQ
profileType: ABOUT
data:
official_name:
retracedId: official_name
name: Official Name
description: "Official Name is the name on the business license(s) associated with the address indicated below.\r\r\n\r\r\nType Not Applicable if there is no English language business license facility name and complete the other question below:\r\r\n\"Facility Name (in local language as per business license):\""
meta: {}
fieldTypeId: SHORT_TEXT
type: GLOBAL
options: []
schema:
type: object
properties:
value:
type: string
minLength: 1
required:
- value
externalIds:
- id: fp-bi-1
version: 1.4.0
provider: slcp
sortingId: 10
sectionId: '1.1'
impactArea: About
impactAreaId: ABOUT
id: official_name
isEditable: false
isVisible: true
value: Developers' Fibre
display_name:
retracedId: display_name
name: Display Name
meta: {}
fieldTypeId: SHORT_TEXT
type: RELATIONAL
options: []
schema:
type: object
properties:
value:
type: string
minLength: 1
required:
- value
externalIds: []
sortingId: 30
sectionId: '1.1'
impactArea: About
impactAreaId: ABOUT
id: display_name
isEditable: true
isVisible: true
value: Developers' Fibre
transliterated_display_name:
retracedId: transliterated_display_name
name: Transliterated Display Name
meta: {}
fieldTypeId: SHORT_TEXT
type: RELATIONAL
options: []
schema:
type: object
properties:
value:
type: string
required:
- value
externalIds: []
sortingId: 40
sectionId: '1.1'
impactArea: About
impactAreaId: ABOUT
id: transliterated_display_name
isEditable: true
isVisible: false
value: nul
# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/retraced/refs/heads/main/openapi/retraced-companies-api-openapi.yml