Get detailed business information
This endpoint retrieves the complete information of a business you have access to. You can retrieve business information using either of the following two methods:
id: Business identifier in our databaseref_id: Business identifier in your system
If you provide both id and ref_id parameters, the id identifier will take precedence.
To search for a business without providing an identifier, please use the business list endpoint.
The business must be linked to your account before you can view or update its information. To do this, use the create/associate a business documentation.
Endpoint
POST https://canadamotorjobs.com/api/v1/{locale}/businesses/get
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
id | string | The business identifier | required or ref_id |
ref_id | string | The business identifier in your system | required or id |
api_token | string | Your API key | required or bearer token |
Errors
| Code | Message |
|---|---|
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Server Error |
Code example
// Laravel PHP
use Illuminate\Support\Facades\Http;
$response = Http::withHeaders([
'Authorization' => 'Bearer your_api_token'
])->post("https://canadamotorjobs.com/api/v1/en/businesses/get", [
'id' => 'abc1234567890' ?? null, // The business identifier in our database
'ref_id' => '1234567890' ?? null, // The business identifier in your system
'api_token' => 'your_api_token' ?? null // Your API key, if you are not using the bearer token
]);
if ($response->successful()) {
$business = $response->json();
// Process business data
} else {
// Handle error
$error = $response->json();
}