Skip to main content
GET
/
company
List companies
curl --request GET \
  --url https://api.instaview.sk/company \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
      }
    }
  ],
  "total": 150,
  "page": 1,
  "limit": 20,
  "totalPages": 8
}
Lists companies accessible to the API key. Behavior differs between regular API keys and ATS integration keys.

​
Overview

The list companies endpoint returns companies based on your API key type. Regular API keys see only their associated company, while ATS keys see all companies they’ve created.

​
Regular API Keys

For regular API keys, this endpoint returns the single company associated with the key: 
{
  "data": {
    "items": [
      {
        "id": "company-uuid",
        "name": "Your Company"
      }
    ],
    "pagination": {
      "total": 1
    }
  }
}

​
ATS Integration Keys

For ATS keys, this endpoint returns all companies created by that ATS key: 
{
  "data": {
    "items": [
      {
        "id": "company-a-uuid",
        "name": "Client Company A"
      },
      {
        "id": "company-b-uuid",
        "name": "Client Company B"
      }
    ],
    "pagination": {
      "total": 2
    }
  }
}

​
Use Cases

  • Company Discovery: Find company IDs for ATS integrations
  • Multi-Tenant Management: List all client companies for ATS platforms
  • Company Verification: Verify company access and existence

​
Pagination

The endpoint supports pagination for ATS keys managing many companies: 
GET /company?page=1&limit=50

ATS Integration Guide

Learn about ATS integration keys

Companies Resource Guide

Understand company management

Get Company

Retrieve a specific company by ID

Authorizations

​
Authorization
string
header
required

API key for authentication using Bearer scheme

Query Parameters

​
page
integer
default:1

Page number (1-based)

Required range: 1 <= x <= 10000
Example:

1

​
limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
Example:

20

​
search
string

Search by company name

Example:

"Acme"

​
companyId
string

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

Response

200 - application/json
​
data
object[]
required

Array of companies

​
total
number
required

Total number of items

Example:

150

​
page
number
required

Current page number

Example:

1

​
limit
number
required

Number of items per page

Example:

20

​
totalPages
number
required

Total number of pages

Example:

8