Introduction

JobClass API specification and documentation.

This documentation aims to provide all the information you need to work with our API.

Important: By default the API uses an access token set in the /.env file with the variable APP_API_TOKEN, whose its value need to be added in the header of all the API requests with X-AppApiToken as key. On the other hand, the key X-AppType must not be added to the header... This key is only useful for the included web client and for API documentation.

Base URL

https://jobclass.laraclassifier.local

Authenticating requests

This API is authenticated by sending an Authorization header with the value "Bearer {YOUR_AUTH_TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Authentication

Log in

Example request:

curl -X POST \
    "https://jobclass.laraclassifier.local/api/auth/login" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Content-Language: en" \
    -H "X-AppApiToken: a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=" \
    -H "X-AppType: docs" \
    -d '{"login":"user@demosite.com","captcha":"consectetur","password":"123456","captcha_key":"pariatur"}'

const url = new URL(
    "https://jobclass.laraclassifier.local/api/auth/login"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Content-Language": "en",
    "X-AppApiToken": "a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=",
    "X-AppType": "docs",
};

let body = {
    "login": "user@demosite.com",
    "captcha": "consectetur",
    "password": "123456",
    "captcha_key": "pariatur"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());


$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://jobclass.laraclassifier.local/api/auth/login',
    [
        'headers' => [
            'Accept' => 'application/json',
            'Content-Language' => 'en',
            'X-AppApiToken' => 'a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=',
            'X-AppType' => 'docs',
        ],
        'json' => [
            'login' => 'user@demosite.com',
            'captcha' => 'consectetur',
            'password' => '123456',
            'captcha_key' => 'pariatur',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (422):

{
    "success": false,
    "message": "An error occurred while validating the data.",
    "errors": {
        "captcha": [
            "validation.captcha_api"
        ]
    }
}

Received response:

Request failed with error:

Log out

requires authentication

Example request:

curl -X GET \
    -G "https://jobclass.laraclassifier.local/api/auth/logout/12" \
    -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Content-Language: en" \
    -H "X-AppApiToken: a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=" \
    -H "X-AppType: docs"

const url = new URL(
    "https://jobclass.laraclassifier.local/api/auth/logout/12"
);

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Content-Language": "en",
    "X-AppApiToken": "a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=",
    "X-AppType": "docs",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());


$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://jobclass.laraclassifier.local/api/auth/logout/12',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
            'Accept' => 'application/json',
            'Content-Language' => 'en',
            'X-AppApiToken' => 'a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=',
            'X-AppType' => 'docs',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

{
    "success": true,
    "message": "You have been logged out. See you soon.",
    "result": null
}

Received response:

Request failed with error:

Forgot password

Example request:

curl -X POST \
    "https://jobclass.laraclassifier.local/api/auth/password/email" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Content-Language: en" \
    -H "X-AppApiToken: a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=" \
    -H "X-AppType: docs" \
    -d '{"login":"user@demosite.com","captcha_key":"optio"}'

const url = new URL(
    "https://jobclass.laraclassifier.local/api/auth/password/email"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Content-Language": "en",
    "X-AppApiToken": "a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=",
    "X-AppType": "docs",
};

let body = {
    "login": "user@demosite.com",
    "captcha_key": "optio"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());


$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://jobclass.laraclassifier.local/api/auth/password/email',
    [
        'headers' => [
            'Accept' => 'application/json',
            'Content-Language' => 'en',
            'X-AppApiToken' => 'a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=',
            'X-AppType' => 'docs',
        ],
        'json' => [
            'login' => 'user@demosite.com',
            'captcha_key' => 'optio',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (422):

{
    "success": false,
    "message": "An error occurred while validating the data.",
    "errors": {
        "captcha": [
            "The security code field is required."
        ]
    }
}

Received response:

Request failed with error:

Reset password token

Reset password token verification

Example request:

curl -X POST \
    "https://jobclass.laraclassifier.local/api/auth/password/token" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Content-Language: en" \
    -H "X-AppApiToken: a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=" \
    -H "X-AppType: docs"

const url = new URL(
    "https://jobclass.laraclassifier.local/api/auth/password/token"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Content-Language": "en",
    "X-AppApiToken": "a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=",
    "X-AppType": "docs",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());


$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://jobclass.laraclassifier.local/api/auth/password/token',
    [
        'headers' => [
            'Accept' => 'application/json',
            'Content-Language' => 'en',
            'X-AppApiToken' => 'a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=',
            'X-AppType' => 'docs',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (422):

{
    "success": false,
    "message": "The given data was invalid.",
    "result": null,
    "errors": {
        "code": [
            "The code field is required."
        ]
    },
    "error_code": 1
}

Received response:

Request failed with error:

Reset password

Example request:

curl -X POST \
    "https://jobclass.laraclassifier.local/api/auth/password/reset" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Content-Language: en" \
    -H "X-AppApiToken: a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=" \
    -H "X-AppType: docs" \
    -d '{"login":"john.doe@domain.tld","password":"js!X07$z61hLA","password_confirmation":"js!X07$z61hLA","captcha_key":"est"}'

const url = new URL(
    "https://jobclass.laraclassifier.local/api/auth/password/reset"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Content-Language": "en",
    "X-AppApiToken": "a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=",
    "X-AppType": "docs",
};

let body = {
    "login": "john.doe@domain.tld",
    "password": "js!X07$z61hLA",
    "password_confirmation": "js!X07$z61hLA",
    "captcha_key": "est"
}

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());


$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://jobclass.laraclassifier.local/api/auth/password/reset',
    [
        'headers' => [
            'Accept' => 'application/json',
            'Content-Language' => 'en',
            'X-AppApiToken' => 'a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=',
            'X-AppType' => 'docs',
        ],
        'json' => [
            'login' => 'john.doe@domain.tld',
            'password' => 'js!X07$z61hLA',
            'password_confirmation' => 'js!X07$z61hLA',
            'captcha_key' => 'est',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (422):

{
    "success": false,
    "message": "An error occurred while validating the data.",
    "errors": {
        "captcha": [
            "The security code field is required."
        ]
    }
}

Received response:

Request failed with error:

Captcha

Get CAPTCHA

Calling this endpoint is mandatory if the captcha is enabled in the Admin panel. Return a JSON data with an 'img' item that contains the captcha image to show and a 'key' item that contains the generated key to send for validation.

Example request:

curl -X GET \
    -G "https://jobclass.laraclassifier.local/api/captcha" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Content-Language: en" \
    -H "X-AppApiToken: a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=" \
    -H "X-AppType: docs"

const url = new URL(
    "https://jobclass.laraclassifier.local/api/captcha"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Content-Language": "en",
    "X-AppApiToken": "a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=",
    "X-AppType": "docs",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());


$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://jobclass.laraclassifier.local/api/captcha',
    [
        'headers' => [
            'Accept' => 'application/json',
            'Content-Language' => 'en',
            'X-AppApiToken' => 'a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=',
            'X-AppType' => 'docs',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (429):

{
    "success": false,
    "message": "Too Many Requests,Please Slow Down",
    "result": null,
    "error_code": 1
}

Received response:

Request failed with error:

Companies

List companies

requires authentication

Example request:

curl -X GET \
    -G "https://jobclass.laraclassifier.local/api/companies?sort=ipsum" \
    -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Content-Language: en" \
    -H "X-AppApiToken: a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=" \
    -H "X-AppType: docs"

const url = new URL(
    "https://jobclass.laraclassifier.local/api/companies"
);

let params = {
    "sort": "ipsum",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Content-Language": "en",
    "X-AppApiToken": "a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=",
    "X-AppType": "docs",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());


$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://jobclass.laraclassifier.local/api/companies',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
            'Accept' => 'application/json',
            'Content-Language' => 'en',
            'X-AppApiToken' => 'a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=',
            'X-AppType' => 'docs',
        ],
        'query' => [
            'sort'=> 'ipsum',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

{
    "success": true,
    "message": null,
    "result": {
        "data": [
            {
                "id": 683,
                "user_id": "1",
                "name": "MISSION IMPOSSIBLE",
                "logo": "files\/us\/683\/3c69eac8aacff148e52e025c675100e2.jpg",
                "description": "Do you have a post to be filled within your company? Find the right candidate in a few clicks at JobClass.",
                "country_code": "US",
                "city_id": null,
                "address": null,
                "phone": "",
                "fax": null,
                "email": null,
                "website": null,
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 682,
                "user_id": "1",
                "name": "LOLA LAND",
                "logo": "files\/us\/682\/a9df8b8e75140f5ec9aade4702333313.png",
                "description": "Do you have a post to be filled within your company? Find the right candidate in a few clicks at JobClass.",
                "country_code": "US",
                "city_id": null,
                "address": null,
                "phone": "",
                "fax": null,
                "email": null,
                "website": null,
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 681,
                "user_id": "1",
                "name": "Amissa Gan",
                "logo": "files\/us\/681\/af3502595a45b4d87c93d6e3cf06d9f8.jpg",
                "description": "Do you have a post to be filled within your company? Find the right candidate in a few clicks at JobClass.",
                "country_code": "US",
                "city_id": null,
                "address": null,
                "phone": "",
                "fax": null,
                "email": null,
                "website": null,
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 680,
                "user_id": "1",
                "name": "Foo Inc.",
                "logo": "files\/us\/680\/2eced1747c0a378f80e0460e2b293f2c.jpg",
                "description": "Use a brief title and description of the ad\r\nMake sure you post in the correct category\r\nAdd a logo to your ad\r\nPut a min and max salary\r\nCheck the ad before publish",
                "country_code": "US",
                "city_id": null,
                "address": null,
                "phone": "",
                "fax": null,
                "email": null,
                "website": null,
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 679,
                "user_id": "1",
                "name": "CAPMARKETER",
                "logo": "files\/us\/679\/d76714ac649b431f757b7011c02c7269.png",
                "description": "Do you have a post to be filled within your company? Find the right candidate in a few clicks at JobClass.",
                "country_code": "US",
                "city_id": null,
                "address": null,
                "phone": "",
                "fax": null,
                "email": null,
                "website": null,
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 659,
                "user_id": "1",
                "name": "Africa Fun",
                "logo": "files\/us\/659\/eceb29817fcd13ef564fd47ab4acfd4f.png",
                "description": "Do you have a post to be filled within your company? Find the right candidate in a few clicks at JobClass.",
                "country_code": "US",
                "city_id": null,
                "address": null,
                "phone": "",
                "fax": null,
                "email": null,
                "website": null,
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 155,
                "user_id": "1455",
                "name": "Gibson LLC",
                "logo": "files\/eg\/1455\/20f53cda5ec88bb3677e24dd28b29e4e.png",
                "description": "Mollitia consequatur iure nemo et modi excepturi iste. Ea commodi placeat et ipsum. Aut qui nemo esse modi voluptas. Itaque repellat veritatis modi suscipit saepe.",
                "country_code": "EG",
                "city_id": "12686",
                "address": null,
                "phone": "+2038730612",
                "fax": "+1-549-759-6938",
                "email": "jana12@donnelly.biz",
                "website": "http:\/\/dolores.com",
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 437,
                "user_id": "302",
                "name": "Block, Bergstrom And Hessel",
                "logo": "files\/it\/302\/774a909e5bb743f173540ff4e8e3703b.png",
                "description": "Quod iste qui ipsum error tempore modi fuga. Dolores qui dolor autem dignissimos est et accusantium a.",
                "country_code": "IT",
                "city_id": "23633",
                "address": null,
                "phone": "9407762823",
                "fax": "+14174134207",
                "email": "toy97@lehner.biz",
                "website": "http:\/\/ea.com",
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 415,
                "user_id": "2196",
                "name": "Beer-Brekke",
                "logo": "files\/ir\/2196\/f702359940760a9710a9c06b483541fe.png",
                "description": "Voluptatibus sed quasi id. Ab ipsam ipsa eaque molestias commodi voluptas rem. Distinctio dolor sed doloremque natus. Expedita cum magnam nisi doloremque fugit.",
                "country_code": "IR",
                "city_id": "21917",
                "address": null,
                "phone": "+18423873459",
                "fax": "+16722248641",
                "email": "rico65@trantow.com",
                "website": "http:\/\/libero.com",
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 650,
                "user_id": "993",
                "name": "Waters, Heaney And Friesen",
                "logo": "files\/qa\/993\/4178a1f36cfd0fb3841fa0a637c12948.png",
                "description": "Quis pariatur aliquid consequatur aperiam. Nisi iure occaecati rerum sit aut tenetur. Soluta in voluptatem sit consequatur ut.",
                "country_code": "QA",
                "city_id": "33502",
                "address": null,
                "phone": "+12429446990",
                "fax": "723-463-1369",
                "email": "susana46@towne.info",
                "website": "http:\/\/autem.com",
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 471,
                "user_id": "1981",
                "name": "Koepp-Douglas",
                "logo": "files\/ar\/1981\/2fa6ff987d952ca0adb1c7afce0c7784.png",
                "description": "Laborum eos porro quibusdam at facere. Et iure inventore et ut consequuntur culpa.",
                "country_code": "AR",
                "city_id": "682",
                "address": null,
                "phone": "6274685869",
                "fax": "717.285.6860",
                "email": "emie60@reynolds.com",
                "website": "http:\/\/aut.com",
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 123,
                "user_id": "533",
                "name": "Bechtelar Group",
                "logo": "files\/id\/533\/801025689856cf095d4c1020420ca1e6.png",
                "description": "Earum deserunt esse consequatur ex ratione rem omnis. Adipisci facere ipsa voluptatem voluptas. Laborum qui quos saepe fuga architecto asperiores pariatur cupiditate. Ut vero quibusdam rerum sit in sint dolor.",
                "country_code": "ID",
                "city_id": "18020",
                "address": null,
                "phone": "+627467884102",
                "fax": "436.972.0846",
                "email": "kenya.parker@lesch.com",
                "website": "http:\/\/accusamus.com",
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 56,
                "user_id": "3",
                "name": "Cruickshank, Gusikowski And Kub",
                "logo": "files\/us\/3\/feb3122a6a3aca78d4b594e082b89099.png",
                "description": "Dolores qui neque repellendus occaecati doloremque. Aut officia optio non eaque vel fuga exercitationem. Ipsa sint quo optio qui aliquid. Debitis voluptatem amet in unde reiciendis repudiandae.",
                "country_code": "US",
                "city_id": "47246",
                "address": null,
                "phone": "+14787721324",
                "fax": "1-684-792-2626",
                "email": "maya.berge@example.net",
                "website": "http:\/\/aliquam.com",
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 452,
                "user_id": "283",
                "name": "Von, McGlynn And Walter",
                "logo": "files\/eg\/283\/7dc20a62dd568ae334332c51fb5555cc.png",
                "description": "Molestias nihil autem doloremque ut. Maiores ducimus blanditiis sed velit sunt assumenda enim. Voluptates illo aut sit repellendus libero culpa. Itaque perferendis et laborum non explicabo iusto.",
                "country_code": "EG",
                "city_id": "12741",
                "address": null,
                "phone": "9279610216",
                "fax": "768.303.8388",
                "email": "easter.lakin@white.biz",
                "website": "http:\/\/fuga.com",
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 172,
                "user_id": "1576",
                "name": "Huel-Lowe",
                "logo": "files\/br\/1576\/b0dc6fa92a7248689768e255c5a2c512.png",
                "description": "Eum molestiae incidunt non tempora reiciendis eos repellat voluptatem. Blanditiis nostrum architecto est impedit quam et pariatur. Rerum est ullam excepturi et voluptate. Laudantium necessitatibus corrupti non repudiandae rem.",
                "country_code": "BR",
                "city_id": "4566",
                "address": null,
                "phone": "5608477603",
                "fax": "681-494-0898",
                "email": "saul17@schmidt.com",
                "website": "http:\/\/debitis.com",
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            },
            {
                "id": 64,
                "user_id": "2062",
                "name": "Kiehn, Crooks And Marquardt",
                "logo": "files\/ua\/2062\/192fa529a7504404658ed36e67b9825c.png",
                "description": "Repellat natus quia omnis molestias. Eveniet culpa doloremque vero repudiandae est expedita. Excepturi maxime voluptatibus doloremque vel est autem iusto.",
                "country_code": "UA",
                "city_id": "39903",
                "address": null,
                "phone": "+13659033263",
                "fax": "+16736909861",
                "email": "smorissette@mitchell.com",
                "website": "http:\/\/delectus.com",
                "facebook": null,
                "twitter": null,
                "linkedin": null,
                "pinterest": null
            }
        ],
        "links": {
            "first": "http:\/\/localhost\/api\/companies?page=1",
            "last": "http:\/\/localhost\/api\/companies?page=42",
            "prev": null,
            "next": "http:\/\/localhost\/api\/companies?page=2"
        },
        "meta": {
            "current_page": 1,
            "from": 1,
            "last_page": 42,
            "links": [
                {
                    "url": null,
                    "label": "&laquo; Previous",
                    "active": false
                },
                {
                    "url": "http:\/\/localhost\/api\/companies?page=1",
                    "label": "1",
                    "active": true
                },
                {
                    "url": "http:\/\/localhost\/api\/companies?page=2",
                    "label": "2",
                    "active": false
                },
                {
                    "url": "http:\/\/localhost\/api\/companies?page=3",
                    "label": "3",
                    "active": false
                },
                {
                    "url": "http:\/\/localhost\/api\/companies?page=4",
                    "label": "4",
                    "active": false
                },
                {
                    "url": "http:\/\/localhost\/api\/companies?page=5",
                    "label": "5",
                    "active": false
                },
                {
                    "url": "http:\/\/localhost\/api\/companies?page=6",
                    "label": "6",
                    "active": false
                },
                {
                    "url": "http:\/\/localhost\/api\/companies?page=7",
                    "label": "7",
                    "active": false
                },
                {
                    "url": "http:\/\/localhost\/api\/companies?page=8",
                    "label": "8",
                    "active": false
                },
                {
                    "url": "http:\/\/localhost\/api\/companies?page=9",
                    "label": "9",
                    "active": false
                },
                {
                    "url": "http:\/\/localhost\/api\/companies?page=10",
                    "label": "10",
                    "active": false
                },
                {
                    "url": null,
                    "label": "...",
                    "active": false
                },
                {
                    "url": "http:\/\/localhost\/api\/companies?page=41",
                    "label": "41",
                    "active": false
                },
                {
                    "url": "http:\/\/localhost\/api\/companies?page=42",
                    "label": "42",
                    "active": false
                },
                {
                    "url": "http:\/\/localhost\/api\/companies?page=2",
                    "label": "Next &raquo;",
                    "active": false
                }
            ],
            "path": "http:\/\/localhost\/api\/companies",
            "per_page": "16",
            "to": 16,
            "total": 663
        }
    }
}

Received response:

Request failed with error:

Get company

Example request:

curl -X GET \
    -G "https://jobclass.laraclassifier.local/api/companies/voluptatem?embed=quibusdam" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Content-Language: en" \
    -H "X-AppApiToken: a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=" \
    -H "X-AppType: docs"

const url = new URL(
    "https://jobclass.laraclassifier.local/api/companies/voluptatem"
);

let params = {
    "embed": "quibusdam",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Content-Language": "en",
    "X-AppApiToken": "a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=",
    "X-AppType": "docs",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());


$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://jobclass.laraclassifier.local/api/companies/voluptatem',
    [
        'headers' => [
            'Accept' => 'application/json',
            'Content-Language' => 'en',
            'X-AppApiToken' => 'a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=',
            'X-AppType' => 'docs',
        ],
        'query' => [
            'embed'=> 'quibusdam',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (404):

{
    "success": false,
    "message": "Page Not Found."
}

Received response:

Request failed with error:

Store company

requires authentication

Example request:

curl -X POST \
    "https://jobclass.laraclassifier.local/api/companies" \
    -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Content-Language: en" \
    -H "X-AppApiToken: a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=" \
    -H "X-AppType: docs" \
    -d ''

const url = new URL(
    "https://jobclass.laraclassifier.local/api/companies"
);

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Content-Language": "en",
    "X-AppApiToken": "a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=",
    "X-AppType": "docs",
};

let body = 

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());


$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://jobclass.laraclassifier.local/api/companies',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
            'Accept' => 'application/json',
            'Content-Language' => 'en',
            'X-AppApiToken' => 'a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=',
            'X-AppType' => 'docs',
        ],
        'json' => [
            'company' => [
                'name' => 'aut',
                'description' => 'commodi',
                [
                    'country_code' => 'US',
                    'name' => 'Foo Inc',
                    'logo' => null,
                    'description' => 'Nostrum quia est aut quas. Consequuntur ut quis odit voluptatem laborum quia.',
                    'city_id' => 20,
                    'address' => '5 rue de l\'Echelle',
                    'phone' => '+17656766467',
                    'fax' => '+80159266712',
                    'email' => 'contact@domain.tld',
                    'website' => 'https://domain.tld',
                    'facebook' => 'non',
                    'twitter' => 'accusantium',
                    'linkedin' => 'necessitatibus',
                    'pinterest' => 'est',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (401):

{
    "success": false,
    "message": "Unauthenticated or Token Expired, Please Login",
    "result": null,
    "error_code": 1
}

Received response:

Request failed with error:

Request

POST api/companies

Body Parameters

company object optional

company[].name string
The company's name.

company[].description string
The company's description.

company[].country_code string
The code of the company's country.

company[].logo file optional
The company's logo.

company[].city_id integer optional
The company city's ID.

company[].address string optional
The company's address.

company[].phone string optional
The company's phone number.

company[].fax string optional
The company's fax number.

company[].email string optional
The company's email address.

company[].website string optional
The company's website URL.

company[].facebook string optional
The company's Facebook URL.

company[].twitter string optional
The company's Twitter URL.

company[].linkedin string optional
The company's LinkedIn URL.

company[].pinterest string optional
The company's Pinterest URL.

Update company

requires authentication

Example request:

curl -X PUT \
    "https://jobclass.laraclassifier.local/api/companies/quibusdam" \
    -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Content-Language: en" \
    -H "X-AppApiToken: a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=" \
    -H "X-AppType: docs" \
    -d ''

const url = new URL(
    "https://jobclass.laraclassifier.local/api/companies/quibusdam"
);

let headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Content-Language": "en",
    "X-AppApiToken": "a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=",
    "X-AppType": "docs",
};

let body = 

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());


$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://jobclass.laraclassifier.local/api/companies/quibusdam',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
            'Accept' => 'application/json',
            'Content-Language' => 'en',
            'X-AppApiToken' => 'a25ydDlKdDRwT2wzYjAxV1hvc0hSUmQxYklTTE1pRHU=',
            'X-AppType' => 'docs',
        ],
        'json' => [
            'company' => [
                'name' => 'quibusdam',
                'description' => 'enim',
                [
                    'country_code' => 'US',
                    'name' => 'Foo Inc',
                    'logo' => null,
                    'description' => 'Nostrum quia est aut quas. Consequuntur ut quis odit voluptatem laborum quia.',
                    'city_id' => 18,
                    'address' => '5 rue de l\'Echelle',
                    'phone' => '+17656766467',
                    'fax' => '+80159266712',
                    'email' => 'contact@domain.tld',
                    'website' => 'https://domain.tld',
                    'facebook' => 'in',
                    'twitter' => 'suscipit',
                    'linkedin' => 'eum',
                    'pinterest' => 'praesentium',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (404):

{
    "success": false,
    "message": "Page Not Found."
}

Received response:

Request failed with error:

Request

PUT api/companies/{id}

URL Parameters

id string