Fields and sub-fields
ROR Schema v2
This page documents the fields and sub-fields in v2 of the ROR metadata schema. For documentation of ROR schema v1 fields and subfields, see https://ror.readme.io/v1/docs/fields. You can also read more about ROR schema versions and a summary of what's new in ROR Schema 2.0.
The following list includes all available fields and sub-fields in version 2 of the ROR metadata schema. For a list of top-level fields only, see ROR data structure. The full JSON schema used for generating and validating ROR records is available at https://github.com/ror-community/ror-schema.
If you'd like to request a change to the ROR metadata schema, please submit a schema change request on our roadmap.
All v2 fields and sub-fields in alphabetical order
Field name | Type | Description | Allowed values |
---|---|---|---|
admin | Object | Container for administrative information about the record | |
admin.created | Object | Container for administrative information about the creation of the record | |
admin.created.date | String | Date the record was added to ROR | Date formatted as YYYY-MM-DD |
admin.created.schema_version | String | ROR schema version that the record was initially created in | 1.0, 2.0 |
admin.last_modified | Object | Container for administrative information about the last modification to the record | |
admin.last_modified.date | String | Date the record was last modified in ROR | Date formatted as YYYY-MM-DD |
admin.last_modified.schema_version | String | ROR schema version that the record was last modified in | 1.0, 2.0 |
domains | Array (of strings) | Fully-qualified domains that belong to the organization, using the smallest number of labels needed encompass the organization (excluding www). Each domain must be unique within ROR; a given domain cannot be listed in multiple ROR records. Multiple values are allowed, however, values cannot be subdomains of other domains listed in the same ROR record. | |
established | Number | Year the organization was established (CE) | Date as YYYY |
external_ids | Object | Container for information about identifiers in other systems ("external identifiers") that are associated with a given organization in ROR | |
external_ids.all | Array (of strings) | All external identifiers of the type specified in external_ids.type | |
external_ids.preferred | String | Preferred external identifier for the organization of the type specified in external_ids.type | |
external_ids.type | String | Identifier system that the identifiers in external_ids.all and external_ids.preferred belong to. Supported systems are Crossref Open Funder Registry (formerly FundRef), GRID (deprecated, but currently supported in ROR for records included in ROR seed data supplied by GRID), ISNI and Wikidata. | fundref, grid, isni, wikidata |
id | String | Unique ROR ID for the organization | |
links | Object | Container for information about URLs related to the organization | |
links.type | String | Type of link listed in links.value | website, wikipedia |
links.value | String | URL of a link related to the organization | Valid URI, according to IETF RFC 3986 |
locations | Object | Container for location information | |
locations.geonames_details | Object | Container for details derived from the GeoNames record for the GeoNames ID in locations.geonames_id | |
locations.geonames_details.country_code | String | ISO 3166-2 code for the country that the organization is located in, from the GeoNames record for the GeoNames ID in locations.geonames_id | Valid 2-character ISO 3166-2 country code (uppercase) |
locations.geonames_details.country_name | String | Name of the country that the organization is located in, from Geonames record for the Geonames ID in locations.geonames_id | |
locations.geonames_details.lat | Number | Latitude of the location identified in locations.geonames_id, from the GeoNames record for that Geonames ID | |
locations.geonames_details.lng | Number | Longitude of the location identified in locations.geonames_id, from the GeoNames record for that GeoNames ID | |
locations.geonames_details.name | String | Name of the location (e.g., city or town) identified in locations.geonames_id, from the GeoNames record for that GeoNames ID. | |
locations.geonames_id | Integer | GeoNames ID for the city or most granular administrative region that the organization is located in. For most records, this ID represents a city, but for organizations not located in a city, the value in this field is ID of the most granular administrative region for the location available in GeoNames. | Valid GeoNames ID |
names | Object | Container for name information | |
names.lang | String | ISO 639-1 language code that identifies the language of a value in names.value. May be used with any name type(s). | Valid 2-character ISO 639-1 language code (lowercase) |
names.types | Array (of strings) | The type(s) associated with the name contained in names.value. Each name must have at least 1 type, and exactly 1 name must have ror_display in its types. Each name can have multiple types, for example ror_display and label. | acronym, alias, label, ror_display |
names.value | String | Name that the organization is (or was) known by, which may be a current official name, former name, alias, acronym, etc. | |
relationships | Object | Container for relationship information | |
relationships.id | String | Unique ROR ID of another organization which is related to the organization | |
relationships.label | String | Name of another organization identified in relationships.id, which is related to the organization | |
relationships.type | String | Type of relationship between the organization and another organization identified in relationships.id | child, parent, related, successor, predecessor |
status | String | Whether the organization is active or not | active, inactive, withdrawn |
types | Array (of strings) | Organization type(s). Allowed types: Education, Healthcare, Company, Archive, Nonprofit, Government, Facility, Funder, Other | archive, company, education, facility, funder, government, healthcare, other |
Updated 6 months ago