Get Company By ID

Retrieve a specific company profile by ID

GET /api/v1/companies/:id

Get Company By ID

cURL

curl --request GET \
  --url https://api.example.com/api/v1/companies/:id

import requests

url = "https://api.example.com/api/v1/companies/:id"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/companies/:id', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/companies/:id",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/companies/:id"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/companies/:id")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/companies/:id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

Endpoint

GET /api/v1/companies/:id

Base URL: http://localhost:3000/api/v1

This endpoint is public and does not require authentication.

Path Parameters

id · string · required

The unique identifier of the company (UUID).

Response

{
  "success": true,
  "data": {
    "id": "uuid",
    "name": "Tech Corp",
    "description": "A leading technology company",
    "logoUrl": "https://...",
    "industry": "Technology",
    "size": "SIZE_201_1000",
    "type": "ENTERPRISE",
    "headquartersLocation": "Cairo, Egypt",
    "foundedYear": 2015,
    "websiteUrl": "https://techcorp.com",
    "benefits": "Health insurance, remote work",
    "linkedIn": "https://linkedin.com/company/techcorp",
    "facebook": "https://facebook.com/techcorp",
    "twitter": "https://twitter.com/techcorp",
    "createdAt": "2025-01-15T10:00:00Z",
    "directJobs": [
      {
        "id": "uuid",
        "title": "Software Engineer",
        "location": "Cairo, Egypt",
        "jobType": "FULL_TIME",
        "workPreference": "HYBRID",
        "experienceLevel": "MID",
        "status": "PUBLISHED"
      }
    ]
  },
  "message": "Company profile retrieved successfully",
  "meta": {
    "timestamp": "2026-04-23T20:00:00.000Z",
    "path": "/companies/uuid",
    "method": "GET"
  }
}

Error Responses

404 Not Found

{
  "success": false,
  "error": {
    "message": "Company not found",
    "statusCode": 404,
    "timestamp": "2026-04-23T20:00:00.000Z",
    "path": "/companies/uuid",
    "method": "GET",
    "details": "Not Found"
  }
}