Retrieve all suppliers, filter by query

curl --request GET \
  --url https://api.zivio.net/api/v3/suppliers \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>'

{
  "suppliers": [
    {
      "id": "77",
      "name": "Company Inc",
      "description": "A detailed biography of the supplier.",
      "headline": "Proven track record in medical procurement",
      "email": "[email protected]",
      "active": "true",
      "vetting_status": "PASSED",
      "tax_number": "9876543234",
      "tax_registered": "true",
      "cis_contractor": "true",
      "payment_terms_in_days": "30",
      "duns_number": "12345678910",
      "linkedin_url": "https://www.linkedin.com/2342342",
      "onboarding_template_name": "Sole Trader Onboarding",
      "invited_by": {
        "id": "66",
        "first_name": "Lorna",
        "last_name": "Lawless",
        "email": "[email protected]",
        "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"
      },
      "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"
      },
      "admin_custom_fields": {
        "key": "value"
      },
      "custom_field_detailed": {
        "key": "key",
        "value": "value"
      },
      "skills": [
        {
          "skill_id": 123,
          "skill_slug": "computer-acquisitions",
          "skill_name": "Computer Acquisitions",
          "why": "10 years experience",
          "precedence": 1
        }
      ],
      "company_registration_number": "123456789",
      "website": "https://www.companyinc.com",
      "supplier_risk_factors": [
        {
          "risk_factor_name": "Insurance Risk",
          "risk_level_name": "RED",
          "dated": "YYYY-MM-DD",
          "effective_at": "2023-11-07T05:31:56Z",
          "comments": "Please upload Professional Indemnity Insurance (minimum £1million) document. (26/07/2024)"
        }
      ],
      "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"
        }
      ],
      "cis_rate": {
        "id": "3",
        "label": "Construction Industry Scheme Gross Payment",
        "tax_reference": "sales",
        "key": "cis_registered_contractors_deduction",
        "rate": "20.0",
        "country_code": "GB",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "archived": "false",
        "custom_fields": {
          "key": "value"
        }
      }
    }
  ]
}

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>'

{
  "suppliers": [
    {
      "id": "77",
      "name": "Company Inc",
      "description": "A detailed biography of the supplier.",
      "headline": "Proven track record in medical procurement",
      "email": "[email protected]",
      "active": "true",
      "vetting_status": "PASSED",
      "tax_number": "9876543234",
      "tax_registered": "true",
      "cis_contractor": "true",
      "payment_terms_in_days": "30",
      "duns_number": "12345678910",
      "linkedin_url": "https://www.linkedin.com/2342342",
      "onboarding_template_name": "Sole Trader Onboarding",
      "invited_by": {
        "id": "66",
        "first_name": "Lorna",
        "last_name": "Lawless",
        "email": "[email protected]",
        "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"
      },
      "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"
      },
      "admin_custom_fields": {
        "key": "value"
      },
      "custom_field_detailed": {
        "key": "key",
        "value": "value"
      },
      "skills": [
        {
          "skill_id": 123,
          "skill_slug": "computer-acquisitions",
          "skill_name": "Computer Acquisitions",
          "why": "10 years experience",
          "precedence": 1
        }
      ],
      "company_registration_number": "123456789",
      "website": "https://www.companyinc.com",
      "supplier_risk_factors": [
        {
          "risk_factor_name": "Insurance Risk",
          "risk_level_name": "RED",
          "dated": "YYYY-MM-DD",
          "effective_at": "2023-11-07T05:31:56Z",
          "comments": "Please upload Professional Indemnity Insurance (minimum £1million) document. (26/07/2024)"
        }
      ],
      "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"
        }
      ],
      "cis_rate": {
        "id": "3",
        "label": "Construction Industry Scheme Gross Payment",
        "tax_reference": "sales",
        "key": "cis_registered_contractors_deduction",
        "rate": "20.0",
        "country_code": "GB",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "archived": "false",
        "custom_fields": {
          "key": "value"
        }
      }
    }
  ]
}

Authorizations

X-API-Key

string

header

required

zivio-tenant-id

string

header

required

Query Parameters

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

suppliers

object[]

Show child attributes

suppliers.id

integer

Example:

"77"

suppliers.name

string

Example:

"Company Inc"

suppliers.description

string

Example:

"A detailed biography of the supplier."

suppliers.headline

string

Example:

"Proven track record in medical procurement"

suppliers.email

string

Example:

"[email protected]"

suppliers.active

string

Example:

"true"

suppliers.vetting_status

string

Example:

"PASSED"

suppliers.tax_number

string

Example:

"9876543234"

suppliers.tax_registered

boolean

Example:

"true"

suppliers.cis_contractor

boolean

Example:

"true"

suppliers.payment_terms_in_days

integer

Example:

"30"

suppliers.duns_number

string

Example:

"12345678910"

suppliers.linkedin_url

string

Example:

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

suppliers.onboarding_template_name

string

Example:

"Sole Trader Onboarding"

suppliers.invited_by

object

Show child attributes

suppliers.invited_by.id

integer

Example:

"66"

suppliers.invited_by.first_name

string

Example:

"Lorna"

suppliers.invited_by.last_name

string

Example:

"Lawless"

suppliers.invited_by.email

string

Example:

"[email protected]"

suppliers.invited_by.org_name

string

Example:

"Example Org"

suppliers.invited_by.org_id

integer

Example:

"186"

suppliers.invited_by.business_unit

string

Example:

"Resident Services"

suppliers.invited_by.division

string

Example:

"Environment & Streetscene"

suppliers.invited_by.department

string

Example:

"Housing"

suppliers.invited_by.vetting_status

string

Example:

"PASSED"

suppliers.invited_by.created_at

string<date-time>

suppliers.invited_by.updated_at

string<date-time>

suppliers.invited_by.custom_fields

object

Show child attributes

suppliers.invited_by.custom_fields.key

string

Example:

"value"

suppliers.invited_by.has_oversight

string

Example:

"true"

suppliers.created_at

string<date-time>

suppliers.updated_at

string<date-time>

suppliers.archived_at

string<date-time>

suppliers.custom_fields

object

Show child attributes

suppliers.custom_fields.key

string

Example:

"value"

suppliers.primary_address

object

Show child attributes

suppliers.primary_address.id

string

Example:

"326"

suppliers.primary_address.line1

string

Example:

"326"

suppliers.primary_address.line2

string

Example:

"Westbourne Grove"

suppliers.primary_address.city

string

Example:

"Brighton"

suppliers.primary_address.region

string

Example:

"East Sussex"

suppliers.primary_address.postcode

string

Example:

"BN99 9XX"

suppliers.primary_address.country_code

string

Example:

"GB"

suppliers.primary_address.formatted

string

Example:

"326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"

suppliers.invoice_address

object

Show child attributes

suppliers.invoice_address.id

string

Example:

"326"

suppliers.invoice_address.line1

string

Example:

"326"

suppliers.invoice_address.line2

string

Example:

"Westbourne Grove"

suppliers.invoice_address.city

string

Example:

"Brighton"

suppliers.invoice_address.region

string

Example:

"East Sussex"

suppliers.invoice_address.postcode

string

Example:

"BN99 9XX"

suppliers.invoice_address.country_code

string

Example:

"GB"

suppliers.invoice_address.formatted

string

Example:

"326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"

suppliers.admin_custom_fields

object

Show child attributes

suppliers.admin_custom_fields.key

string

Example:

"value"

suppliers.custom_field_detailed

object

Show child attributes

suppliers.custom_field_detailed.key

string

Example:

"key"

suppliers.custom_field_detailed.value

string

Example:

"value"

suppliers.skills

object[]

Show child attributes

suppliers.skills.skill_id

integer

Example:

123

suppliers.skills.skill_slug

string

Example:

"computer-acquisitions"

suppliers.skills.skill_name

string

Example:

"Computer Acquisitions"

suppliers.skills.why

string

Example:

"10 years experience"

suppliers.skills.precedence

integer

Example:

1

suppliers.company_registration_number

string

Example:

"123456789"

suppliers.website

string

Example:

"https://www.companyinc.com"

suppliers.supplier_risk_factors

object[]

Show child attributes

suppliers.supplier_risk_factors.risk_factor_name

string

Example:

"Insurance Risk"

suppliers.supplier_risk_factors.risk_level_name

string

Example:

"RED"

suppliers.supplier_risk_factors.dated

string

Example:

"YYYY-MM-DD"

suppliers.supplier_risk_factors.effective_at

string<date-time>

suppliers.supplier_risk_factors.comments

string

Example:

"Please upload Professional Indemnity Insurance (minimum £1million) document. (26/07/2024)"

suppliers.bank_accounts

object[]

Show child attributes

suppliers.bank_accounts.id

string

Example:

"132"

suppliers.bank_accounts.currency

string

Example:

"GBP"

suppliers.bank_accounts.country_code

string

Example:

"GB"

suppliers.bank_accounts.account_holder_name

string

Example:

"Organistation Ltd"

suppliers.bank_accounts.account_holder_type

string

Example:

"Business"

suppliers.bank_accounts.account_number

string

Example:

"****1234"

suppliers.bank_accounts.sort_code

string

Example:

"123456"

suppliers.bank_accounts.created_at

string<date-time>

suppliers.bank_accounts.updated_at

string<date-time>

suppliers.cis_rate

object

Show child attributes

suppliers.cis_rate.id

integer

Example:

"3"

suppliers.cis_rate.label

string

Example:

"Construction Industry Scheme Gross Payment"

suppliers.cis_rate.tax_reference

enum<string>

Available options:

sales,

cis

suppliers.cis_rate.key

string

Example:

"cis_registered_contractors_deduction"

suppliers.cis_rate.rate

string

Example:

"20.0"

suppliers.cis_rate.country_code

string

Example:

"GB"

suppliers.cis_rate.created_at

string<date-time>

suppliers.cis_rate.updated_at

string<date-time>

suppliers.cis_rate.archived

boolean

Example:

"false"

suppliers.cis_rate.custom_fields

object

Show child attributes

suppliers.cis_rate.custom_fields.key

string

Example:

"value"

Retrieve a skill by ID Create a Supplier

⌘I

Endpoints

Authorizations

Query Parameters

Response