Skip to main content
GET
/
companies
/
{id}
Get Company
curl --request GET \
  --url https://api.example.com/companies/{id}
{
  "success": true,
  "data": {
    "data.id": "<string>",
    "data.name": "<string>",
    "data.slug": "<string>",
    "data.industry": "<string>",
    "data.country": "<string>",
    "data.timezone": "<string>",
    "data.currency": "<string>",
    "data.registration_number": "<string>",
    "data.tax_id": "<string>",
    "data.address": "<string>",
    "data.phone": "<string>",
    "data.logo_url": "<string>",
    "data.status": "<string>",
    "data.settings": {},
    "data.created_at": "<string>",
    "data.updated_at": "<string>"
  }
}
Retrieve detailed information about a specific company by its ID.

Path Parameters

id
string
required
Company UUID

Response

success
boolean
Indicates if the request was successful
data
object
The company object
data.id
string
Company UUID
data.name
string
Company name
data.slug
string
Company slug identifier
data.industry
string
Industry sector
data.country
string
Country location
data.timezone
string
Timezone identifier
data.currency
string
Currency code
data.registration_number
string
Registration number
data.tax_id
string
Tax identification
data.address
string
Physical address
data.phone
string
Contact phone
data.logo_url
string
Logo URL
data.status
string
Company status
data.settings
object
Company settings (JSON)
data.created_at
string
Creation timestamp (ISO 8601)
data.updated_at
string
Last update timestamp (ISO 8601)

Request Example

cURL
curl -X GET https://api.companyflow.com/companies/123e4567-e89b-12d3-a456-426614174000 \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Response Example

200 OK
{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Acme Corporation",
    "slug": "acme-corp",
    "industry": "Technology",
    "country": "United States",
    "timezone": "America/New_York",
    "currency": "USD",
    "registration_number": "123456789",
    "tax_id": "98-7654321",
    "address": "123 Main St, New York, NY 10001",
    "phone": "+1-555-0100",
    "logo_url": "https://example.com/logo.png",
    "status": "active",
    "settings": null,
    "created_at": "2026-03-03T10:00:00Z",
    "updated_at": "2026-03-03T10:00:00Z"
  }
}
400 Bad Request
{
  "success": false,
  "message": "invalid company id"
}
500 Internal Server Error
{
  "success": false,
  "message": "internal server error"
}

Error Responses

Status CodeDescription
400Invalid company ID format (must be valid UUID)
500Internal server error

Build docs developers (and LLMs) love