/ror/organizations/search

POST /api/ror/organizations/search

Price: 1 credit

Search research organizations on ROR by query and filters

How to use it

Search research organizations on the Research Organization Registry (ROR). Combine a free-text query with filters on country, organization type and status. Returns the same rich organization objects as the get-by-id endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Free-text query across organization names and metadata
• country string nullable — ISO country code of the organization (examples: "US", "GB")
• type string nullable — Organization type (one of: "education", "funder", "healthcare", "company", "archive", "nonprofit", "government", "facility", "other")
• status string nullable — Organization status (one of: "active", "inactive", "withdrawn")
• count integer required — Number of organizations to return (min: 1)

Response

• @type string (default: "RorOrganization")
• id string required
• status string nullable
• established integer nullable
• types array (default: [])
• name string nullable
• aliases array (default: [])
• acronyms array (default: [])
• labels array (default: [])
• domains array (default: [])
• links array (default: [])
  • @type string (default: "RorLink")
  • type string nullable
  • value string nullable
• locations array (default: [])
  • @type string (default: "RorLocation")
  • geonames_id integer nullable
  • name string nullable
  • latitude number nullable
  • longitude number nullable
  • country_code string nullable
  • country_name string nullable
  • subdivision_code string nullable
  • subdivision_name string nullable
  • continent_code string nullable
  • continent_name string nullable
• external_ids array (default: [])
  • @type string (default: "RorExternalId")
  • type string nullable
  • preferred string nullable
  • all array (default: [])
• relationships array (default: [])
  • @type string (default: "RorRelationship")
  • type string nullable
  • id string nullable
  • label string nullable
• admin object nullable
  • @type string (default: "RorAdmin")
  • created_at string nullable
  • created_schema_version string nullable
  • last_modified_at string nullable
  • last_modified_schema_version string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.