Vocabulary

List countries

get

Returns active countries. Optional query filters by country label or ISO 3166 code (case-insensitive substring). When there are no matches, data is an empty array.

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Query parameters

querystringOptional

Filter by label or ISO 3166 code substring.

Responses

200Success

application/json

get/api/vocab/countries/

GET /api/vocab/countries/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [
    {
      "id": 1,
      "label": "text",
      "iso3166code": "text"
    }
  ]
}

List launch types

get

Returns all launch type vocabulary records for launch platforms.

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Responses

200Success

application/json

get/api/vocab/launch-types/

GET /api/vocab/launch-types/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [
    {
      "id": 1,
      "label": "text",
      "description": "text",
      "source": "text"
    }
  ]
}

List location methods

get

Returns all location method vocabulary records used when describing sample collection locations.

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Responses

200Success

application/json

get/api/vocab/location-methods/

GET /api/vocab/location-methods/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [
    {
      "id": 1,
      "label": "text",
      "description": "text",
      "source": "text"
    }
  ]
}

List material types (flat)

get

Returns all material type vocabulary rows as a flat list.

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Responses

200Success

application/json

get/api/vocab/material-types/

GET /api/vocab/material-types/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [
    {
      "id": 1,
      "label": "text",
      "alt_label": "text",
      "description": "text",
      "material_type_uri": "text",
      "parent_material_types": [
        "text"
      ],
      "source": "text",
      "scheme_uri": "text",
      "for_registration": true,
      "suppress_from_search": true
    }
  ]
}

List material types (hierarchical)

get

Returns material types rooted at entries with no parent links; each node includes a children array. Types with multiple parents appear under each parent.

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Responses

200Success

application/json

get/api/vocab/material-types/hierarchical/

GET /api/vocab/material-types/hierarchical/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [
    {
      "id": 1,
      "label": "text",
      "alt_label": "text",
      "description": "text",
      "material_type_uri": "text",
      "for_registration": true,
      "suppress_from_search": true,
      "children": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    }
  ]
}

List object types (flat)

get

Returns all object type vocabulary records as a flat list.

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Responses

200Success

application/json

get/api/vocab/object-types/

GET /api/vocab/object-types/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [
    {
      "id": 1,
      "label": "text",
      "hierarchical_label": "text",
      "description": "text",
      "uri": "text",
      "parent_type": "text",
      "scheme_name": "text",
      "scheme_uri": "text"
    }
  ]
}

List object types (hierarchical)

get

Returns object types rooted at entries with no parent type; each node includes a children array.

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Responses

200Success

application/json

get/api/vocab/object-types/hierarchical/

GET /api/vocab/object-types/hierarchical/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [
    {
      "label": "text",
      "hierarchical_label": "text",
      "description": "text",
      "uri": "text",
      "children": "text"
    }
  ]
}

List platform types

get

Returns all platform type vocabulary records for collection platforms.

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Responses

200Success

application/json

get/api/vocab/platform-types/

GET /api/vocab/platform-types/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [
    {
      "id": 1,
      "label": "text",
      "description": "text",
      "source": "text"
    }
  ]
}

List sampling methods

get

Returns sampling method vocabulary. Optional q filters by label (case-insensitive substring). When q is provided and nothing matches, data is an empty array.

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Query parameters

qstringOptional

Filter by label substring (case-insensitive).

Responses

200Success

application/json

get/api/vocab/sampling-methods/

GET /api/vocab/sampling-methods/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [
    {
      "label": "text",
      "description": "text",
      "method_uri": "text",
      "source": "text",
      "scheme_uri": "text"
    }
  ]
}