Get Vendor | Coperniq API

const url = 'https://api.coperniq.io/v1/vendors/vendorId';
const options = {
  method: 'GET',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": 42,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-04-10T11:45:00Z",
  "title": "GreenTech Consulting",
  "description": "Specializes in sustainable energy solutions and environmental consulting.",
  "address": [
    "1234 Elm Street",
    "Suite 500",
    "Springfield, IL 62704"
  ],
  "isActive": true,
  "primaryEmail": "contact@greentechconsulting.com",
  "primaryPhone": "+1-217-555-0198",
  "number": 1001,
  "custom": {
    "industry": "Renewable Energy",
    "rating": "A+"
  },
  "vendorType": "CONSULTANT",
  "website": "https://www.greentechconsulting.com",
  "projectIds": [
    101,
    102,
    103
  ]
}

Retrieve a specific vendor by ID.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

vendorIdstringRequired

Query parameters

include_contactsbooleanOptionalDefaults to false

Whether to include associated contacts in the response. Defaults to false unless explicitly set to true.

Response

Vendor details

idinteger

Unique identifier

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

titlestring

Record title/name

descriptionstring or null

Record description

addresslist of strings

Record location/address

isActiveboolean

Whether the record is active

primaryEmailstring or nullformat: "email"

Primary contact email

primaryPhonestring or null

Primary contact phone

numberinteger

Record number (e.g., 1234)

custommap from strings to any

Custom fields

vendorTypeenum or null

The type of vendor

websitestring or null

Vendor website URL

projectIdslist of integers

IDs of projects this vendor is linked to

Errors

401

Unauthorized Error

404

Not Found Error