Organization Lookup

The Organization Lookup API searches organizations and brand profiles.

Unless otherwise noted, the following rules apply when specifying input parameters:

  • All strings are case insensitive.
  • Multiple words should be joined with a space. The input is URL encoded where spaces are translated to "%20". For example, Apple Inc. is encoded to Apple%20Inc.
  • If a search includes multiple words, the complete string is searched.
  • Wildcards and boolean logic are not supported:
    • *, ?, AND, and OR

For information on how to find organizations with partial or incomplete information, refer to our Company Search documentation.

Permissions

Permission Description
rw_organization_admin Manage organization pages and retrieve reporting data
r_compliance Retrieve posts, comments, and likes on behalf of an authenticated member for compliance monitoring and archiving. This is a private permission and access is granted to select developers.

Note

Organization lookup API is protected by 3-legged OAuth token. For more information, Authorization Code Flow (3-legged OAuth).

Admin and Non-Admin Access

Important

Some of these API calls require that the authenticated member has the role type ADMINISTRATOR for the requested organization or organization brand. For information on how to retrieve roles through the API, see Organization Access Control.

APIs that do not require administrative access will only return the following fields:

  • id
  • name
  • localizedName
  • localizedWebsite
  • vanityName
  • logoV2
  • locations
  • primaryOrganizationType

APIs that require administrative access will return all available Organization and Organization Brand fields.

Retrieve Organizations

Use the Organization Lookup API to find organizations using organization id, vanity name, or an email domain.

Organization URNs are in the format urn:li:organization:{organization id} and represent a LinkedIn Company Page.

Retrieve an Administered Organization

You can use the organization ID to lookup organization information on behalf of authenticated members with role type ADMINISTRATOR for that organization. API calls with insufficient permissions returns 403 Forbidden.

Sample Request

GET https://api.linkedin.com/rest/organizations/{organization ID}
GET https://api.linkedin.com/v2/organizations/{organization ID}

Batch Get Administered Organizations

You can fetch a list of organizations with the associated IDs on behalf of authenticated members with role type ADMINISTRATOR for those organizations. API calls with insufficient permissions receive a 403 Forbidden response.

Note

The request must include a header for Restli Protocol 2.0.0 as X-Restli-Protocol-Version: 2.0.0.

Sample Request

GET https://api.linkedin.com/rest/organizations?ids=List({organization ID})
GET https://api.linkedin.com/v2/organizations?ids=List({organization ID})

Sample Response

{
    "results": {
        "2973321": {
            "vanityName": "myStartupDotCom",
            "localizedName": "myStartupInc"",
            "foundedOn": {
                "year": 1998
            },
            "coverPhoto": {
                "cropped": "urn:li:media:/gcrc/dms/image/Z561BAQF8zT9beoHupA/company-background_10000/0/1544648748713?e=1631905200&v=beta&t=ZSHOeHDliP1QEmnMoIg3GPUcLocCXMx0OaU_X2MJNks",
                "original": "urn:li:media:/gcrc/dms/image/Z561BAQF8zT9beoHupA/company-background_10000/0/1544648748713?e=1631905200&v=beta&t=ZSHOeHDliP1QEmnMoIg3GPUcLocCXMx0OaU_X2MJNks",
                "cropInfo": {
                    "x": 0,
                    "width": 646,
                    "y": 0,
                    "height": 220
                }
            },
            "groups": [
                "urn:li:group:32255",
                "urn:li:group:5466555",
                "urn:li:group:54668"
                ]
            }
        }
}

Batch Get Non-Administered Organizations

You can fetch a list of organizations that the authenticated member does not administer using the following API. The returned fields are more limited than the equivalent endpoint for administered organizations.

The request must include a header for Restli Protocol 2.0.0 as X-Restli-Protocol-Version: 2.0.0.

Note

organizationsLookup usage does not require administrator access.

Sample Request

GET https://api.linkedin.com/rest/organizationsLookup?ids=List(1000,0000)
GET https://api.linkedin.com/v2/organizationsLookup?ids=List(1000,0000)

Sample Response

{
    "results": {
        "2414183": {
            "vanityName": "devtestco111",
            "localizedName": "DevTestCooo",
            "name": {
                "localized": {
                    "es_ES": "DevTestCo Espanol 34566",
                    "zh_CN": "Test Company12345",
                    "ja_JP": "DevTestCo \"Quote\"​",
                    "en_US": "DevTestCooo"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "primaryOrganizationType": "NONE",
            "locations": [
                {
                    "locationType": "HEADQUARTERS",
                    "address": {
                        "geographicArea": "CA",
                        "country": "US",
                        "city": "Sunnyvale",
                        "postalCode": "94087"
                    },
                    "geoLocation": "urn:li:geo:102376651",
                    "streetAddressFieldState": "OPT_OUT"
                },
            . . .

Retrieve Organization Details by URN Decoration

You can use decoration on any organization URN using the projection query parameter to request specific fields. Decoration is limited to selecting Non-Admin Fields.

For example:

&projection=(elements*(entity~(vanityName)))

Sample Response

{
    "elements": [
        {
            "entity~": {
                "vanityName": "linked-it"
            },
            "entity": "urn:li:organization:1032984"
        }
    ]
}

Look Up Organization Primary Type

Retrieve an organization's primary type by requesting the primaryTypeOrganization field when looking up an organization.

Sample Request

GET https://api.linkedin.com/rest/organizations/1000?projection=(primaryOrganizationType)
GET https://api.linkedin.com/v2/organizations/1000?projection=(primaryOrganizationType)

Sample Response

{
        "primaryOrganizationType": "NONE"
}

Find Organization by Vanity Name

You can look up organizations using vanityName to retrieve Non-Admin Fields. The API can return schools (such as Universities), organization brands (previously known as Showcase Pages), and organizations (companies). To differentiate between entities, primaryOrganizationType field returns one of the following possible organzational entity values:

  • SCHOOL
  • BRAND
  • NONE - no primary type

Sample API Calls to Lookup

Find an Organization - LinkedIn

​​GET https://api.linkedin.com/rest/organizations?q=vanityName&vanityName=LinkedIn

Find a Brand - LinkedIn Marketing Solutions

GET https://api.linkedin.com/rest/organizations?q=vanityName&vanityName=linkedin-marketing-solutions

Find a School - Boise State University

GET https://api.linkedin.com/rest/organizations?q=vanityName&vanityName=boisestate

Find an Organization - LinkedIn

​​GET https://api.linkedin.com/v2/organizations?q=vanityName&vanityName=LinkedIn

Find a Brand - LinkedIn Marketing Solutions

GET https://api.linkedin.com/v2/organizations?q=vanityName&vanityName=linkedin-marketing-solutions

Find a School - Boise State University

GET https://api.linkedin.com/v2/organizations?q=vanityName&vanityName=boisestate

Sample Response - For Boise State University Lookup

{
   "paging": {
       "start": 0,
       "count": 10,
       "links": [],
       "total": 1
   },
   "elements": [{
       "vanityName": "boisestate",
       "localizedName": "Boise State University",
       "schoolAttributes": {
           "hierarchyClassification": "UNIVERSITY",
           "type": "PUBLIC",
           "yearLevel": "FOUR_YEAR",
           "legacySchool": "urn:li:school:18235"
       },
       "name": {
           "localized": {
               "en_US": "Boise State University"
           },
           "preferredLocale": {
               "country": "US",
               "language": "en"
           }
       },
       "primaryOrganizationType": "SCHOOL",
       "locations": [{
           "address": {
               "geographicArea": "Idaho",
               "country": "US",
               "city": "Boise",
               "line1": "301 S. CAPITOL BLVD.",
               "postalCode": "83702"
           },
           "staffCountRange": "SIZE_11_TO_50",
           "geoLocation": "urn:li:geo:100754108",
           "phoneNumber1": {
               "number": "2084263335"
           },
           "locationType": "OTHER",
           "description": {
               "localized": {
                   "en_US": "Boise State Downtown"
               },
               "preferredLocale": {
                   "country": "US",
                   "language": "en"
               }
           },
           "localizedDescription": "Boise State Downtown",
           "streetAddressFieldState": "UNSET_OPT_OUT"
       }, {
           "address": {
               "geographicArea": "Idaho",
               "country": "US",
               "city": "Nampa",
               "line2": "Nampa Campus Aspen Classroom Bldg.",
               "line1": "6002 Birch Lane",
               "postalCode": "83687"
           },
           "staffCountRange": "SIZE_1",
           "geoLocation": "urn:li:geo:105011711",
           "streetAddressFieldState": "UNSET_OPT_OUT"
       }],
       "id": 11832,
       "localizedWebsite": "https://boisestate.edu",
       "logoV2": {
           "cropped": "urn:li:digitalmediaAsset:C4D0BAQE6V6rj_w1yVQ",
           "original": "urn:li:digitalmediaAsset:C4D0BAQE6V6rj_w1yVQ",
           "cropInfo": {
               "x": 0,
               "width": 0,
               "y": 0,
               "height": 0
           }
       }
   }]
}

How to Use the API Response for Finding School Organization URN

The API returns an id field, which is the organization URN (urn:li:organization:11832) for Boise State:

Boise State ID

Caution

Use id field as shown above for school organization. The legacySchool field has a school URN that has near term plans for depreciation,
e.g. "legacySchool": "urn:li:school:18235"

Find Organization by Email Domain

You can look up organizations using emailDomain to retrieve Non-Admin Fields. This returns an array of organizations that match the specified email domain.

Sample Request

GET https://api.linkedin.com/rest/organizations?q=emailDomain&emailDomain=linkedin.com
GET https://api.linkedin.com/v2/organizations?q=emailDomain&emailDomain=linkedin.com

Sample Response

{
    "elements": [
        {
            "id": 0000,
            "localizedName": "LinkedIn",
            "logoV2": {
                "cropped": "urn:li:digitalmediaAsset:C4D0BAQHnSQoLUKZxqA",
                "cropInfo": {
                    "x": 0,
                    "width": 0,
                    "y": 0,
                    "height": 0
                }
            },
            "name": {
                "localized": {
                    "cs_CZ": "LinkedIn",
                    "da_DK": "LinkedIn",
                    "de_DE": "LinkedIn",
                    "en_US": "LinkedIn",
                    "es_ES": "LinkedIn",
                    "fr_FR": "LinkedIn",
                    "in_ID": "LinkedIn",
                    "it_IT": "LinkedIn",
                    "ja_JP": "LinkedIn",
                    "ko_KR": "LinkedIn",
                    "ms_MY": "LinkedIn",
                    "nl_NL": "LinkedIn",
                    "no_NO": "LinkedIn",
                    "pl_PL": "LinkedIn",
                    "pt_BR": "LinkedIn",
                    "ro_RO": "LinkedIn",
                    "ru_RU": "LinkedIn",
                    "sv_SE": "LinkedIn",
                    "th_TH": "LinkedIn",
                    "tr_TR": "LinkedIn",
                    "zh_CN": "LinkedIn (\u9886\u82f1)",
                    "zh_TW": "LinkedIn"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "vanityName": "linkedin"
        }
    ],
    "paging": {
        "total": 10,
        "count": 10,
        "start": 0,
        "links": []
    }
}

Retrieve Organization Follower Count

The Organization Network Size API provides the ability to retrieve the number of first-degree connections (followers) for any organization.

Sample Request

GET https://api.linkedin.com/rest/networkSizes/urn:li:organization:1234567?edgeType=CompanyFollowedByMember
GET https://api.linkedin.com/v2/networkSizes/urn:li:organization:1234567?edgeType=CompanyFollowedByMember

Sample Response

{
  "firstDegreeSize": 219145
}

Retrieve Organization Brands

Use the Organization Lookup API to find organization brands using an organization brand ID, parent organization ID, or a vanity name.

Organization brand URNs are in the format urn:li:organizationBrand:{id} and represent LinkedIn Showcase Pages.

Note

organizationsBrands Lookup usage does not require administrator access.

Retrieve an Administered Organization Brand

You can use the organization brand ID to lookup Organization Brands information on behalf of authenticated members with role type ADMINISTRATOR for that brand. API calls with insufficient permissions receive a 403 Forbidden response.

Sample Request

GET https://api.linkedin.com/rest/organizationBrands/{organization brand ID}
GET https://api.linkedin.com/v2/organizationBrands/{organization brand ID}

Sample Response

{
    "$URN": "urn:li:organizationBrand:11111111",
    "alternativeNames": [],
    "autoCreated": false,
    "defaultLocale": {
        "country": "US",
        "language": "en"
    },
    "description": {
        "localized": {
            "en_US": "Please follow LinkedIn's Company Page at https://www.linkedin.com/company/linkedin."
        },
        "preferredLocale": {
            "country": "US",
            "language": "en"
        }
    },
    "id": 11111111,
    "industries": [
        "urn:li:industry:94"
    ],
    "localizedDescription": "Please follow LinkedIn's Company Page at https://www.linkedin.com/company/linkedin.",
    "localizedName": "example.com",
    . . .

Batch Get Administered Organization Brands

You can fetch a list of Organization Brands information on behalf of authenticated members with role type ADMINISTRATOR for those brands. API calls with insufficient permissions receive a 403 Forbidden response.

The request must include a header for Restli Protocol 2.0.0 as X-Restli-Protocol-Version: 2.0.0.

Sample Request

GET https://api.linkedin.com/rest/organizationBrands?ids=({organization brand ID})
GET https://api.linkedin.com/v2/organizationBrands?ids=({organization brand ID})

Sample Response

{
    "elements": [
        {
            "$URN": "urn:li:organizationBrand:11111111",
            "alternativeNames": [],
            "autoCreated": false,
            "defaultLocale": {
                "country": "US",
                "language": "en"
            },
            "description": {
                "localized": {
                    "en_US": "Please follow LinkedIn's Company Page at https://www.linkedin.com/company/linkedin."
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "id": 11111111,
            "industries": [
                "urn:li:industry:94"
            ],
            "localizedDescription": "Please follow LinkedIn's Company Page at https://www.linkedin.com/company/linkedin.",
            "localizedName": "example.com",
            "localizedSpecialties": [],
            "name": {
                "localized": {
                    "en_US": "test_product"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "parentRelationship": {
                "parent": "urn:li:organization:2222222"
            },
            "specialties": [],
            "vanityName": "example.com",
            "versionTag": "2",
            "website": {
                "localized": {
                    "en_US": "http://www.example.com/"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            }
        . . .

Find Administered Organization Brands by Parent Organization

You can use this API to look up information about Organization Brands using the parent organization URN on behalf of authenticated members with role type ADMINISTRATOR. This returns an array of brands that belong to the specified parent organization and only brands that are administered by the authenticated member are returned.

Sample Request

GET https://api.linkedin.com/rest/organizations?q=parentOrganization&parent={organization URN}
GET https://api.linkedin.com/v2/organizations?q=parentOrganization&parent={organization URN}

Sample Response

{
    "elements": [
        {
            "id": 7777777,
            "localizedDescription": "When your friends & colleagues make the news, we make sure you know.",
            "localizedName": "Example",
            "logo": {
                "cropInfo": {
                    "height": 0,
                    "width": 0,
                    "x": 0,
                    "y": 0
                },
                "cropped": "urn:li:media:/p/8/000/206/3de/1111111.png",
                "original": "urn:li:media:/p/8/000/206/3de/1111111.png"
            },
            "name": {
                "localized": {
                    "en_US": "Example"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "staffCountRange": "SIZE_2_TO_10",
            "vanityName": "example"
        },
        {
            "id": 8888888,
            "localizedDescription": "Please follow LinkedIn's Company Page at https://www.linkedin.com/company/linkedin.",
            "localizedName": "Example2.com",
            . . .

Batch Get Non-Administered Organization Brands

You can fetch a list of Organization Brands that the authenticated member does not administer using the following API. The returned fields are more limited than the equivalent endpoint for administered organization brands.

The request must include a header for Restli Protocol 2.0.0 as X-Restli-Protocol-Version: 2.0.0.

Sample Request

GET https://api.linkedin.com/rest/organizationBrandsLookup?ids=List(5025865,35625943)
GET https://api.linkedin.com/v2/organizationBrandsLookup?ids=List(5025865,35625943)

Sample Response

{
    "results": {
        "35625943": {
            "name": {
                "localized": {
                    "en_US": "Test Showcase"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "primaryOrganizationType": "BRAND",
            "vanityName": "test-showcase",
            "localizedName": "Test Showcase",
            "id": 35625943
        },
        "5025865": {
            "vanityName": "lms-test-co",
            "localizedName": "LinkedIn Demo Account",
            "name": {
                "localized": {
                    "ja_JP": "テスト",
                    "en_US": "LinkedIn Demo Account"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "primaryOrganizationType": "BRAND",
            "id": 5025865,
            "localizedWebsite": "http://www.linkedin-ei123.com",
            "logoV2": {
                "cropped": "urn:li:digitalmediaAsset:C510BAQEfmCIulaw0Qw",
                "original": "urn:li:digitalmediaAsset:C510BAQEfmCIulaw0Qw",
                "cropInfo": {
                    "x": 0,
                    "width": 1024,
                    "y": 0,
                    "height": 1024
                }
            }
        }
    },
    "statuses": {
        "35625943": 200,
        "5025865": 200
    },
    "errors": {}
}

Retrieve Organization Brand Details by URN Decoration

You can use decoration on any organization brand URN using the projection query parameter to request specific fields. Decoration is limited to selecting Non-Admin Fields.

For example:

&projection=(elements*(entity~(vanityName)))

Sample Response

{
    "elements": [
        {
            "entity~": {
                "vanityName": "linked-it"
            },
            "entity": "urn:li:organizationBrand:11111111"
        }
    ]
}

Find Organization Brand by Vanity Name

You can look up organization brands using vanityName to retrieve Non-Admin Fields.

Sample Request

GET https://api.linkedin.com/rest/organizationBrands?q=vanityName&vanityName=Linkedin
GET https://api.linkedin.com/v2/organizationBrands?q=vanityName&vanityName=Linkedin

Retrieve Organization Logos & Cover Photos

The following media fields are returned by the Organization Lookup API for both organizations and organization brands:

The value formats are digitalmediaAsset URNs. For example, urn:li:digitalmediaAsset:123ABC. These URNs need to be decorated in order to return image URLs. Include ~:playableStreams in the projection parameter to request the image URLs. For example:

projection=(elements(*(logoV2(original~:playableStreams))))

For more information, see Digital Media Asset URNs.

Sample Request

GET https://api.linkedin.com/rest/organizationsLookup?projection=(results({Orgaization_ID}(logoV2(original~:playableStreams,cropped~:playableStreams,cropInfo))))&ids=List({Orgaization_ID})
GET https://api.linkedin.com/v2/organizationsLookup?projection=(results({Orgaization_ID}(logoV2(original~:playableStreams,cropped~:playableStreams,cropInfo))))&ids=List({Orgaization_ID})

Schema

Organization

Field Name Type Description Admin Only
alternativeNames LocaleString [] Alternative names of the entity. There can be multiple names per locale. True
coverPhotoV2 CroppedImage The entity's background cover image. The sizes may vary, so clients should handle the given height and width accordingly. True
defaultLocale Locale Default locale of the entity. True
deleted.time long Deleted timestamp True
description MultiLocaleString Description for the entity. True
foundedOn Date Date when the entity was founded. True
groups GroupUrn[] Groups featured by the organizational entity. Default to empty array. True
id long Unique identifier for the entity. False
industries IndustryURN[] The industries associated with the entity. True
localizedDescription string The locale-specific description of the entity. True
localizedName string The locale-specific name of the entity. False
localizedSpecialties string[] The locale-specific, admin-defined specialty tags of the entity. True
localizedWebsite string The locale-specific website of the entity. False
locations LocationInfo[] List of locations for the entity. False
name MultiLocaleString Entity's name. False
parentRelationship. parent string URN of the parent organization. True
parentRelationship. organizationRelationshipType string Type of relationship from child to parent organizations. Possible values:
  • SUBSIDIARY: This organization is a subsidiary of the parent.
  • ACQUISITION: This organization was acquired by the parent.
  • SCHOOL: An associated school of the parent organization. For example, a University's School of Law or a remote campus, or a company-owned university.
  • True
    parentRelationship. relationshipStatus string The status of a relationship between organizations. Possible values:
  • ACTIVE: The relationship is active.
  • INACTIVE: The relationship is inactive.
  • True
    specialties.tags[] string [] Admin-defined specialty tags of the entity. True
    vanityName string Entity's unique name used in URLs. False
    versionTag string Tag indicating version. True
    website MultiLocaleString Entity's website. True
    staffCountRange string Range of the number of staff associated with this entity. Possible values:
  • SIZE_1
  • SIZE_2_TO_10
  • SIZE_11_TO_50
  • SIZE_51_TO_200
  • SIZE_201_TO_500
  • SIZE_501_TO_1000
  • SIZE_1001_TO_5000
  • SIZE_5001_TO_10000
  • SIZE_10001_OR_MORE
  • True
    schoolAttributes SchoolAttributes School-specific attributes of the organization. If this field exists, then this entity is a school. True
    overviewPhotoV2 CroppedImage The image used in the Overview tab on the organization's page. True
    logoV2 CroppedImage The entity’s logo. The sizes may vary greatly, i.e., 50x50, 100x60, 400x400, so clients should handle the given height and width accordingly. False
    organizationStatus string Status of the organization, such as operating or out of business. Possible values:
  • OPERATING: Currently operating
  • OPERATING_SUBSIDIARY: Operating as a subsidiary
  • REORGANIZING: Undergoing reorganization
  • OUT_OF_BUSINESS: Out of business
  • ACQUIRED: Acquired by another organization
  • True
    organizationType string Type of organization. Possible values:
  • PUBLIC_COMPANY: A public company
  • EDUCATIONAL: An educational institution
  • SELF_EMPLOYED: A self-employed business
  • GOVERNMENT_AGENCY: A government agency
  • NON_PROFIT: A non-profit organization
  • SELF_OWNED: A self-owned business
  • PRIVATELY_HELD: A privately held business
  • PARTNERSHIP: A partnership
  • True
    primaryOrganizationType string Type of primary organization being used in the lookup. Possible values:
  • SCHOOL: Identifies the organizational entity as a school
  • BRAND: identifies the organizational entity as a brand
  • NONE: Identifies the organizational entity as not having a primary type.
  • False

    Organization Brand

    Field Name Type Description Admin Only
    alternativeNames LocaleString [] Alternative names of the entity. There can be multiple names per locale. True
    coverPhotoV2 CroppedImage The entity's background cover image. The sizes may vary, so clients should handle the given height and width accordingly. True
    defaultLocale Locale Default locale of the entity. True
    description MultiLocaleString Map of locale to localized entity's description. True
    foundedOn Date Date when the entity was founded. True
    id long Unique identifier for the entity. False
    industries IndustryURN[] The industries associated with the entity. True
    localizedDescription string The locale-specific description of the entity. True
    localizedName string The locale-specific name of the entity. False
    localizedSpecialties string[] The locale-specific, admin-defined specialty tags of the entity. True
    localizedWebsite string The locale-specific website of the entity. False
    name MultiLocaleString Entity's name. False
    parentRelationship. parent string URN of the parent organization. True
    specialties.tags[] string [] Admin-defined specialty tags of the entity. True
    vanityName string Entity's unique name used in URLs. False
    versionTag string Tag indicating version. True
    website MultiLocaleString Entity's website. True
    logoV2 CroppedImage The entity’s logo. The sizes may vary greatly, i.e., 50x50, 100x60, 400x400, so clients should handle the given height and width accordingly. False
    pinnedPost string The URN of the entity's pinned post. True
    autoCreated boolean Whether the entity was auto-created. True

    CroppedImage

    Field Name Type Description
    height int Height of the image
    width int Width of the image
    x int X coordinate of the corner
    y int Y coordinate of the corner
    cropped string Location of the cropped image
    original string Location of the original image

    Date

    Field Name Type Description
    day int Day
    month int Month
    year int Year

    Locale

    Field Name Type Description
    country string An uppercase, two-letter country code as defined by ISO-3166.
    language string A lowercase, two-letter language code as defined by ISO-639.

    LocaleString

    Field Name Type Description
    locale Locale Locale key
    value string String value for locale

    MultiLocaleString

    Field Name Type Description
    localized map (string->string) Map of locale to localized entity's description.
    preferredLocale string The preferred locale to use for entity’s description.

    SchoolAttributes

    Field Name Type Description
    hierarchyClassification string The classification for school hierarchy. Possible values:
  • CONSORTIUM_SYSTEM: A collection of schools and education providers.
  • UNIVERSITY: A university, typically containing individual schools within it.
  • INDEPENDENT_SCHOOL_COLLEGE_PROVIDER: Provides degrees, certs, etc., but typically does not contain individual schools within it.
  • REMOTE_CAMPUS: A separate campus that is at a distance from the primary college area.
  • DISTANCE_LEARNING: A school that provides education solely through online channels.
  • legacySchool string Legacy school urn for the organization.
    type string The type of institution. Possible values:
  • PUBLIC: A public school operated by the state, as opposed to being a private enterprise.
  • PRIVATE: A private school, also known as independent school, non-governmental, or non-state school, not administered by a government.
  • PROFIT: A for-profit school operated by a private, profit-seeking business.
  • yearLevel string Classification of the length of the institution's educational programs. These levels are defined by the National Center for Education Statistics (http://nces.ed.gov/pubs2015/2015097rev.pdf). Possible values:
  • UNDER_TWO_YEAR: As defined by National Center for Education Statistics: 'This group includes any post-secondary institution that offers programs of less than 2 years’ duration below the baccalaureate level, as well as occupational and vocational schools with programs that do not exceed 1,800 contact hours.'
  • TWO_YEAR: As defined by the National Center for Education Statistics: ': Any post-secondary institution that offers programs of at least 2 but less than 4 years’ duration, as well as occupational and vocational schools with programs of at least 1,800 hours and academic institutions with programs of less than 4 years. Does not include bachelor's-degree-granting institutions where the baccalaureate program can be completed in 3 years.'
  • FOUR_YEAR: As defined by the National Center for Education Statistics: 'Any post-secondary institution that offers programs of at least 4 years’ duration or one that offers programs at or above the baccalaureate level, as well as schools that offer post-baccalaureate certificates only or those that offer graduate programs only.'