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

PropertyTypeDescription
idstringThe UUID for the object.
$filter operators: equals in not in
namestringThe company's name.
$filter operators: equals starts with contains in not in is known is unknown
websitestringThe company's website URL.
$filter operators: equals starts with contains in not in is known is unknown
descriptionstringA longer description of the company.
$filter operators: equals starts with contains in not in is known is unknown
logostringA URL for the company's logo.
addressesobject[]The company's addresses. Included when addresses are populated on the response.

Address Properties

Each entry in addresses has the following properties:

PropertyTypeDescription
idstringThe UUID for the address.
typestringThe address type. One of physical, mailing, post_office_box, billing, shipping, headquarters, branch, or other.
streetstringThe street address.
unitstringThe unit, suite, or apartment number.
postal_codestringThe postal or ZIP code.
citystringThe city.
statestringThe state or province.
countrystringThe country.
latitudenumberThe latitude coordinate.
longitudenumberThe 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
        }
    ]
}