Skip to main content

Company API

Manage your company profile, offices, hiring pipelines, and team members.

Company Profile

MethodEndpointDescription
GET/api/companies/profileGet company profile
GET/api/companies/show/{id}Get company by ID
POST/api/companies/update/{id}Update company
POST/api/companies/update-logo/{id}Upload logo
GET/api/companies/createGet form data

Get Profile

GET /api/companies/profile?subdomain=acme

Returns full company data including name, description, logo, offices, pipelines, benefits, values, and career page settings.

Update Company

POST /api/companies/update/{id}?subdomain=acme
{
"name": "Acme Corp",
"description": "Technology company...",
"website": "https://example.com",
"phone": "+1-555-0100",
"address": "123 Example Street",
"country_id": 15
}

Offices

MethodEndpointDescription
GET/api/company-offices/indexList offices
POST/api/company-offices/storeCreate office
GET/api/company-offices/show/{id}Get office
POST/api/company-offices/update/{id}Update office
DELETE/api/company-offices/destroy/{id}Delete office

Create Office

POST /api/company-offices/store?subdomain=acme
{
"name": "Vienna HQ",
"address": "Wipplingerstraße 20",
"country_id": 15,
"state_id": 221,
"city": "Vienna",
"zipcode": "1010",
"is_default": true
}

Pipelines

MethodEndpointDescription
GET/api/company-pipline/indexList pipelines with stages
POST/api/company-pipline/storeCreate pipeline
GET/api/company-pipline/show/{id}Get pipeline
POST/api/company-pipline/update/{id}Update pipeline
DELETE/api/company-pipline/destroy/{id}Delete pipeline

List Pipelines

GET /api/company-pipline/index?subdomain=acme

Returns all pipelines with their stages (Screening → Interview → Offer → Hiring).

Create Pipeline

POST /api/company-pipline/store?subdomain=acme
{
"name": "Engineering Pipeline"
}

Team Members

MethodEndpointDescription
GET/api/company-users/indexList team members
POST/api/company-users/storeInvite member
GET/api/company-users/show/{id}Get member
POST/api/company-users/update-role/{id}Update role
DELETE/api/company-users/destroy/{id}Remove member

Invite Team Member

POST /api/company-users/store?subdomain=acme
{
"email": "john@company.com",
"first_name": "John",
"last_name": "Doe",
"role_type": "Recruiter"
}

Roles: Admin, Recruiter, Viewer


Contracted Companies

MethodEndpointDescription
GET/api/contracted-companiesList companies
POST/api/contracted-companiesCreate company
GET/api/contracted-companies/show/{id}Get company
POST/api/contracted-companies/update/{id}Update company
DELETE/api/contracted-companies/destroy/{id}Delete company

Create Contracted Company

POST /api/contracted-companies?subdomain=acme
{
"name": "Client Corp",
"email": "hr@clientcorp.com",
"phone": "+49123456789",
"address": "Berliner Str. 15",
"country_id": 58,
"pipeline_id": 1
}