CompaniesGet Single Company

Get Single Company

Retrieve a specific Company identified by its unique ID.

curl -X GET "https://api.getkini.com/companies/123/" \
  -H "Content-Type: application/json" \
  -H "Company-Id: 123" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": 123,
  "name": "John Doe",
  "slug": "example_string",
  "ats": "bullhorn",
  "ats_name": "John Doe",
  "partner": 42,
  "partner_company_id": "example_string",
  "website": "example_string",
  "logo": "example_string",
  "primary_color": "example_string",
  "street": "example_string",
  "city": "New York",
  "country": "USA",
  "postcode": "example_string",
  "job_sync_active": true,
  "candidate_sync_active": true,
  "contact_name": "John Doe",
  "contact_email": "user@example.com",
  "contact_phone": "+1-555-0123",
  "jobs_last_synced_at": "2024-12-25T10:00:00Z",
  "fallback_job": 42,
  "status": "invited",
  "is_test": true,
  "magic_link": "example_string",
  "created_at": "2024-12-25T10:00:00Z",
  "updated_at": "2024-12-25T10:00:00Z"
}
GET
/companies/{id}/
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Bearer API Key Authentication. Include your API key in the Authorization header.

Bearer API Key Authentication. Include your API key in the Authorization header.
path
idinteger
Required

Unique Kini ID of the company

header
Company-Idinteger
Required

Kini ID of the company the key is associated with

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Bearer API Key Authentication. Include your API key in the Authorization header.

Path Parameters

idinteger
Required

Unique Kini ID of the company

Headers

Company-Idinteger
Required

Kini ID of the company the key is associated with

Responses

idinteger

Unique Kini ID of the company

namestring

Display name of the company

slugstring

URL-friendly slug of the company

atsstring

Slug of the ATS integration the company is linked to

Allowed values:bullhorneploygreenhouseharvestheyrecruitjobylonoracle-taleorecruiteesmartrecruitersteamtailorumantisworkableworkdayzvoove
ats_namestring

Human-readable name of the linked ATS

partnerinteger

Kini ID of the owning partner

partner_company_idstring

External identifier of the company in the partner's system

websitestring

Company website URL

logostring

URL of the company logo

primary_colorstring

Hex color used to brand the company's job board

streetstring
citystring
countrystring
postcodestring
job_sync_activeboolean

Whether the company's job synchronization is activated

candidate_sync_activeboolean

Whether the company's candidate synchronization is activated

contact_namestring
contact_emailstring
contact_phonestring
jobs_last_synced_atstring

Timestamp of the last successful job sync

fallback_jobinteger

Kini ID of the job used as a fallback when the ATS export fails

statusstring

Lifecycle status of the company

Allowed values:invitedrequestedactivefailingdeactivateddeleted
is_testboolean

Whether the company is marked as a test record

magic_linkstring

URL of the active magic link for the company, if any

created_atstring

Timestamp of when the company was first created

updated_atstring

Timestamp of when the company was last updated