GET https://ed.link/api/v2/companies/:company_id
Retrieve a public Company, its parent company (if one exists), and its immediate child companies.
You must provide an application's publishable key (pk_...) as a bearer token to access this endpoint.
Request Parameters
| Parameter | Type | Description |
|---|---|---|
company_id | string | The UUID of the desired Company. |
The response includes:
company— the requested company with its addresses populatedparent— the company's parent in the public dataset, ornullif it has no parent. Includes addresses when present.children— companies that are direct children of the requested company. Each child includes its addresses.
Sample Request
axios.get('https://ed.link/api/v2/companies/00000000-0000-0000-0000-000000000000', {
headers: {
authorization: `Bearer ${publishable_key}`
}
});
Sample Response
{
"$data": {
"company": {
"id": "44444444-4444-4444-4444-444444444444",
"name": "Acme Learning",
"website": "https://acme-learning.example.com",
"description": "An educational technology company.",
"logo": null,
"addresses": [
{
"id": "33333333-3333-3333-3333-333333333333",
"type": "headquarters",
"street": "200 Innovation Drive",
"unit": null,
"postal_code": "94107",
"city": "San Francisco",
"state": "CA",
"country": "US",
"latitude": 37.7699,
"longitude": -122.3933
}
]
},
"parent": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Acme Group",
"website": "https://acme.example.com",
"description": "A parent company for educational technology brands.",
"logo": null,
"addresses": [
{
"id": "22222222-2222-2222-2222-222222222222",
"type": "headquarters",
"street": "100 Market Street",
"unit": "Suite 400",
"postal_code": "94105",
"city": "San Francisco",
"state": "CA",
"country": "US",
"latitude": 37.7897,
"longitude": -122.3972
}
]
},
"children": []
},
"$request": "00000000-0000-0000-0000-000000000000"
}