For Developers
Companies Overview
An Edlink Company represents an educational vendor or organization in the Public Data API, such as an edtech provider, publisher, or service company. Companies can be linked to one another through parent/child relationships.
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the object. $filter operators: equals in not in |
name | string | The company's name. $filter operators: equals starts with contains in not in is known is unknown |
website | string | The company's website URL. $filter operators: equals starts with contains in not in is known is unknown |
description | string | A longer description of the company. $filter operators: equals starts with contains in not in is known is unknown |
logo | string | A URL for the company's logo. |
addresses | object[] | The company's addresses. Included when addresses are populated on the response. |
Address Properties
Each entry in addresses has the following properties:
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the address. |
type | string | The address type. One of physical, mailing, post_office_box, billing, shipping, headquarters, branch, or other. |
street | string | The street address. |
unit | string | The unit, suite, or apartment number. |
postal_code | string | The postal or ZIP code. |
city | string | The city. |
state | string | The state or province. |
country | string | The country. |
latitude | number | The latitude coordinate. |
longitude | number | The longitude coordinate. |
JSON Example
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Acme Learning",
"website": "https://acme.example.com",
"description": "An educational technology company.",
"logo": null,
"addresses": [
{
"id": "11111111-1111-1111-1111-111111111111",
"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
}
]
}
