Skip to main content
GET
/
public
/
v2
/
companies
/
{company_id}
cURL
curl --request GET \
  --url https://api.example.com/public/v2/companies/{company_id}
{
  "id": 123,
  "updated_time": "2023-11-07T05:31:56Z",
  "domain": "<string>",
  "previous_status": "<string>",
  "status_changed_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "company_status": "<string>",
  "company_custom_fields": [
    {
      "id": 123,
      "updated_time": "2023-11-07T05:31:56Z",
      "field_name": "<string>",
      "field_value": "<string>"
    }
  ]
}

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. The company was successfully retrieved.

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