Skip to main content

Overview

The Companies API allows you to view and update your company profile. Regular API keys can only access their associated company, while ATS integration keys can manage multiple companies.

Resource Structure

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Acme Corporation",
  "website": "https://acme.com",
  "industry": "Technology",
  "size": "51-200",
  "location": {
    "city": "San Francisco",
    "countryCode": "US"
  },
  "settings": {
    "timezone": "America/Los_Angeles",
    "locale": "en-US"
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Required Scopes

OperationRequired Scope
Get companyread:companies
Update companywrite:companies

Retrieving Company

const response = await fetch(
  `https://api.instaview.sk/companies/${companyId}`,
  { headers: { 'Authorization': `Bearer ${apiKey}` } }
);

const { data } = await response.json();

Updating Company

await fetch(`https://api.instaview.sk/companies/${companyId}`, {
  method: 'PATCH',
  headers: {
        'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Acme Corporation',
    website: 'https://acme.com',
    industry: 'Technology'
  })
});

ATS Integration

ATS keys can create and manage multiple companies:
// Create a new company (ATS keys only)
const company = await fetch('https://api.instaview.sk/companies', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${atsApiKey}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Client Company',
    website: 'https://client.com'
  })
});

Next Steps