Institutions

Search institutions

get

Returns up to limit institutions whose label matches query (case-insensitive substring), or whose ROR matches ror when that parameter is provided. When nothing matches, data is an empty array.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

limitintegerOptional

Maximum rows to return (clamped between 1 and 100, default 10).

querystringOptional

Case-insensitive substring filter on institution label. Ignored when ror is set.

rorstringOptional

Exact ROR filter (9-character id or https://ror.org/… URL).

Responses

200Success

application/json

get/api/institutions/

GET /api/institutions/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [
    {
      "id": 1,
      "institution_type": "text",
      "label": "text",
      "alt_label": "text",
      "description": "text",
      "country": "text",
      "country_subdivision": "text",
      "city": "text",
      "ror": "text",
      "parent_institutions": "text",
      "can_edit": "text",
      "created_by": 1
    }
  ]
}

Create institution

post

Creates a new institution record (e.g. for affiliations, collectors or archives).

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

institution_typestring · nullableOptional

labelstring · max: 200Required

alt_labelstring · max: 200 · nullableOptional

descriptionstring · nullableOptional

countrystring · nullableOptional

country_subdivisionstring · max: 255 · nullableOptional

citystring · max: 255 · nullableOptional

rorstring · max: 25 · nullableOptional

parent_institutionsinteger[]Write-onlyOptional

created_byinteger · nullableOptional

Responses

201Success

application/json

post/api/institutions/

POST /api/institutions/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 196

{
  "institution_type": "text",
  "label": "text",
  "alt_label": "text",
  "description": "text",
  "country": "text",
  "country_subdivision": "text",
  "city": "text",
  "ror": "text",
  "parent_institutions": [
    1
  ],
  "created_by": 1
}

201Success

{
  "data": {
    "id": 1,
    "institution_type": "text",
    "label": "text",
    "alt_label": "text",
    "description": "text",
    "country": "text",
    "country_subdivision": "text",
    "city": "text",
    "ror": "text",
    "parent_institutions": "text",
    "can_edit": "text",
    "created_by": 1
  }
}