Supported Formats

json

GET /api/v1/companies
List companies

Supported Formats

json

Params

Param name Description
filter_name
optional

Search filter on company name


Value:

Must be String

rows
optional

Amount of rows per page of the resultset. Default is 10.


Value:

Must be File

page
optional

Page of resultset. Default is 1.


Value:

Must be File


GET /api/v1/company/:id
Show a company

Supported Formats

json

POST /api/v1/companies
Creates a company

Supported Formats

json

Params

Param name Description
name
required

Company name


Value:

Must be String

website
optional

Company website url


Value:

Must be String

lat
optional

Company location latitude


Value:

Must be Float

lng
optional

Company location longitude


Value:

Must be Float

city
optional

Company location city


Value:

Must be String

country
optional

Company location country


Value:

Must be String

recruiter_group_id
optional

ADMIN ONLY: id of the recruiter group that this company should be attached to


Value:

Must be a number


PUT /api/v1/company/:id
Update a company

Supported Formats

json

Params

Param name Description
name
optional

Company name


Value:

Must be String

website
optional

Company website url


Value:

Must be String

lat
optional

Company location latitude


Value:

Must be Float

lng
optional

Company location longitude


Value:

Must be Float

city
optional

Company location city


Value:

Must be String

country
optional

Company location country


Value:

Must be String


DELETE /api/v1/company/:id
Destroy a company

Supported Formats

json