Skip to main content
GET
/
company
/
{id}
Get company by ID
curl --request GET \
  --url https://api.instaview.sk/company/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Acme Corporation",
  "createdAt": "2024-11-16T10:30:00Z",
  "updatedAt": "2024-11-16T10:30:00Z",
  "description": "Leading technology company",
  "ownerEmail": "owner@example.com",
  "metadata": {
    "externalCompanyId": "COMP-12345",
    "industry": "Technology"
  }
}
Retrieves a specific company by ID. Access rules differ between regular API keys and ATS integration keys.

​
Overview

The get company endpoint returns complete information about a single company, including name, website, industry, and settings. Regular API keys can only access their own company, while ATS keys can access companies they’ve created.

​
Access Rules

​
Regular API Keys

Regular API keys can only access their associated company: 
// ✅ Can access own company
GET /company/{own-company-id}

// ❌ Cannot access other companies
GET /company/{other-company-id}
// Returns: 403 Forbidden

​
ATS Integration Keys

ATS keys can access any company they’ve created: 
// ✅ Can access companies created by this ATS key
GET /company/{ats-managed-company-id}

// ❌ Cannot access companies not managed by this ATS key
GET /company/{unmanaged-company-id}
// Returns: 403 Forbidden

​
Use Cases

  • Company Profile Display: Show company information in your UI
  • Access Verification: Verify company access before operations
  • Company Details: Retrieve company settings and configuration

​
Response Data

The response includes company information:
  • Basic details (name, website, industry)
  • Company size and location
  • Settings (timezone, locale)
  • Timestamps (created, updated)

​
Error Scenarios

  • 404 Not Found: Company doesn’t exist
  • 403 Forbidden: Company is not accessible with your API key type

ATS Integration Guide

Learn about ATS integration keys and access rules

Companies Resource Guide

Understand company management

Update Company

Modify company information

Authorizations

​
Authorization
string
header
required

API key for authentication using Bearer scheme

Path Parameters

​
id
string<uuid>
required

Query Parameters

​
companyId
string

Required for ATS API keys to specify which company to access. Ignored for standard company API keys.

Response

200 - application/json
​
id
string
required

Company ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string
required

Company name

Example:

"Acme Corporation"

​
createdAt
string
required

Created timestamp

Example:

"2024-11-16T10:30:00Z"

​
updatedAt
string
required

Updated timestamp

Example:

"2024-11-16T10:30:00Z"

​
description
string

Company description

Example:

"Leading technology company"

​
ownerEmail
string<email>

Email of the company owner

Maximum string length: 254
Example:

"owner@example.com"

​
metadata
object

Custom metadata

Example:
{
  "externalCompanyId": "COMP-12345",
  "industry": "Technology"
}