Skip to main content
GET
Get a Supplier

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. The access token from POST /oauth/token is sent as a bearer token. Request only the scopes you need.

zivio-tenant-id
string
header
required

Your Zivio organisation identifier. The regional API endpoints serve every Zivio organisation, so each request must identify yours.

Path Parameters

id
integer
required

Supplier ID

Response

Supplier details

id
integer
name
string
description
string
headline
string
tax_number
string
tax_registered
boolean
Example:

true

tax_jurisdiction
string
duns_number
string
utr
string
ni_number
string
company_registration_number
string
website
string
display_location
string
display_location_country_code
string
vetting_status
enum<string>
Available options:
NOT REGISTERED,
PASSED,
FAILED,
PENDING
Example:

"NOT REGISTERED"

uuid
string
onboarding_template_id
integer
linkedin_url
string
cis_contractor
boolean
Example:

true

cis_rate
object | null
payment_terms_in_days
integer
primary_address
object
invoice_address
object
onboarding_template_name
string
admin_custom_fields
object

Key-value pairs of custom field data

accreditations
string
skills
string
supplier_risk_factors
string
badges
string[]
invited_by
object | null
archived_at
string
archived_reason
string
custom_fields
object

Key-value pairs of custom field data

created_at
string
updated_at
string
project_matches_count
integer