Skip to main content
GET
cURL

Path Parameters

company_id
integer
required

Query Parameters

structure
enum<string>
default:NESTED

Format of custom fields in response. NESTED returns array of objects with id, field_name, field_value. FLAT returns object with field names as keys.

Available options:
FLAT,
NESTED

Response

OK. Returns the company. If no company matches the given ID, this endpoint still returns 200, with body {"message": "No company found.", "data": []} — check the response body, not the status code, to detect a missing company.

id
integer
required
read-only
updated_time
string<date-time>
required
read-only
domain
string
required
previous_status
string | null
required
read-only
status_changed_at
string<date-time> | null
required
read-only
name
string
company_status
string
company_custom_fields
object[]