GET
/
suppliers
curl --request GET \
  --url https://api.zivio.net/api/v3/suppliers \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>'
{
  "id": "77",
  "name": "Company Inc",
  "description": "A detailed biography of the supplier.",
  "headline": "Proven track record in medical procurement",
  "email": "jack_jones@companyinc.com",
  "active": "true",
  "vetting_status": "PASSED",
  "tax_number": "9876543234",
  "duns_number": "12345678910",
  "linkedin_url": "https://www.linkedin.com/2342342",
  "website": "https://www.companyinc.com",
  "company_registration_number": "123456789",
  "onboarding_template_name": "Sole Trader Onboarding",
  "invited_by": {
    "id": "66",
    "first_name": "Lorna",
    "last_name": "Lawless",
    "email": "lorna@example.com",
    "org_name": "Example Org",
    "org_id": "186",
    "business_unit": "Resident Services",
    "division": "Environment & Streetscene",
    "department": "Housing",
    "vetting_status": "PASSED",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "custom_fields": {
      "key": "value"
    },
    "has_oversight": "true"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "custom_fields": {
    "key": "value"
  },
  "admin_custom_fields": {
    "key": "value"
  },
  "custom_field_detailed": {
    "key": "key",
    "value": "value"
  },
  "primary_address": {
    "id": "326",
    "line1": "326",
    "line2": "Westbourne Grove",
    "city": "Brighton",
    "region": "East Sussex",
    "postcode": "BN99 9XX",
    "country_code": "GB",
    "formatted": "326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"
  },
  "invoice_address": {
    "id": "326",
    "line1": "326",
    "line2": "Westbourne Grove",
    "city": "Brighton",
    "region": "East Sussex",
    "postcode": "BN99 9XX",
    "country_code": "GB",
    "formatted": "326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"
  },
  "skills": [
    {
      "skill_id": 123,
      "skill_slug": "computer-acquisitions",
      "skill_name": "Computer Acquisitions",
      "why": "10 years experience",
      "precedence": 1
    }
  ],
  "bank_accounts": [
    {
      "id": "132",
      "currency": "GBP",
      "country_code": "GB",
      "account_holder_name": "Organistation Ltd",
      "account_holder_type": "Business",
      "account_number": "****1234",
      "sort_code": "123456",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required
​
zivio-tenant-id
string
header
required

Query Parameters

​
q
string

Query string. search in first_name, last_name and email

​
created
string

Date range [2020-01-01+TO+2020-01-30] to search based on created timestamp for object.

​
updated
string

Date range [2020-01-01+TO+2020-01-30] to search based on updated timestamp for object.

​
sort
string

Results are sorted by created desc as default. Ordering may be specified, available options are ['created', 'updated'], which can be combined in a comma separated list, e.g. updated:desc,created:asc

​
vetting_status
string

Filter by a status, [pending, failed, pending]

​
limit
integer

Number of results returned per request

​
page
integer

Paginate results when number of results exceeds limit

Response

200
*/*
ok
​
id
integer
Example:

"77"

​
name
string
Example:

"Company Inc"

​
description
string
Example:

"A detailed biography of the supplier."

​
headline
string
Example:

"Proven track record in medical procurement"

​
email
string
Example:

"jack_jones@companyinc.com"

​
active
string
Example:

"true"

​
vetting_status
string
Example:

"PASSED"

​
tax_number
string
Example:

"9876543234"

​
duns_number
string
Example:

"12345678910"

​
linkedin_url
string
Example:

"https://www.linkedin.com/2342342"

​
website
string
Example:

"https://www.companyinc.com"

​
company_registration_number
string
Example:

"123456789"

​
onboarding_template_name
string
Example:

"Sole Trader Onboarding"

​
invited_by
object
​
created_at
string
​
updated_at
string
​
archived_at
string
​
custom_fields
object
​
admin_custom_fields
object
​
custom_field_detailed
object
​
primary_address
object
​
invoice_address
object
​
skills
object[]
​
bank_accounts
object[]
Retrieve a skill by IDCreate a Supplier