B2SHARE Vocabulary API:s

List all vocabularies

List all vocabularies without any filtering.

  HTTP method: GET

  URL path: /api/vocabularies

  Required parameters: None

  Optional parameters: q, sort, page, size

  Status code on success: 200

  Returns: A list of vocabularies in JSON format

Command:

curl "https://$B2SHARE_HOST/api/vocabularies"

Returns:

{
  "hits": {
    "hits": [
      {
        "id": "affiliations",
        "pid_type": "aff",
        "count": 119172,
        "is_custom_vocabulary": true,
        "links": {
          "self": "https://b2share.eudat.eu/api/affiliations"
        }
      },
      ...
    ],
    "total": 26
  },
  "links": {
    "self": "https://b2share.eudat.eu/api/vocabularies/?facets=%7B%7D",
    "next": "https://b2share.eudat.eu/api/vocabularies/?facets=%7B%7D&page=2"
  }

Get a vocabulary

List all entries in a vocabulary without any filtering

  HTTP method: GET

  URL path: /api/vocabularies/<vocabulary-id>
  OR: /api/<vocabulary-id>

  Required parameters: vocabulary-id

  Optional parameters: q, sort, page, size

  Status code on success: 200

  Returns: A list of entries in the vocabulary in JSON format.

Note! Some special vocabularies have their own endpoint on the api-root. These vocabularies are: awards, funders, affiliations, names, and subjects

Command:

curl "https://$B2SHARE_HOST/api/vocabularies/resourcetypes"

Returns:

{
  "hits": {
    "hits": [
      {
        "id": "publication-annotationcollection",
        "created": "2025-10-24T12:11:23.906949+00:00",
        "updated": "2025-10-27T10:53:45.646551+00:00",
        "links": {
          "self": "https://b2share.eudat.eu/api/vocabularies/resourcetypes/publication-annotationcollection"
        },
        "revision_id": 3,
        "title": {
          "cs": "Kolekce anotací",
          "de": "Anmerkungssammlung",
          "en": "Annotation collection",
          "sv": "Annoteringssamling"
        },
        "icon": "file alternate",
        "tags": [
          "depositable",
          "linkable"
        ],
        "props": {
          "csl": "report",
          "type": "publication",
          "eurepo": "info:eu-repo/semantics/technicalDocumentation",
          "subtype": "publication-annotationcollection",
          "schema.org": "https://schema.org/Collection",
          "marc21_type": "publication",
          "datacite_type": "",
          "openaire_type": "publication",
          "marc21_subtype": "annotationcollection",
          "datacite_general": "Collection",
          "openaire_resourceType": "0009"
        },
        "type": "resourcetypes"
      },
      ...
    ],
    "total": 49
  },
  "links": {
    "self": "https://b2share.eudat.eu/api/vocabularies/resourcetypes?page=1&size=25&sort=title",
    "next": "https://b2share.eudat.eu/api/vocabularies/resourcetypes?page=2&size=25&sort=title"
  }

Search in vocabulary

Search for entries in a vocabulary

  HTTP method: GET

  URL path: /api/vocabularies/<vocabulary-id>?q=<query>
  OR: /api/<vocabulary-id>?q=<query>

  Required parameters: vocabulary-id, query

  Supported query-parameters: q, sort, page, size

  Status code on success: 200

  Returns: A list of search results in JSON format.

Note! Some special vocabularies have their own endpoint on the api-root. These vocabularies are: awards, funders, affiliations, names, and subjects

Command:

curl "https://$B2SHARE_HOST/api/vocabularies/resourcetypes?q=audio"

Returns:

{
  "hits": {
    "hits": [
      {
        "id": "audio",
        "created": "2025-10-24T12:11:24.266545+00:00",
        "updated": "2025-10-27T10:53:46.797246+00:00",
        "links": {
          "self": "https://b2share.eudat.eu/api/vocabularies/resourcetypes/audio"
        },
        "revision_id": 3,
        "title": {
          "cs": "Audio",
          "de": "Audio",
          "en": "Audio",
          "sv": "Audio"
        },
        "icon": "volume up",
        "tags": [
          "depositable",
          "linkable"
        ],
        "props": {
          "csl": "document",
          "type": "audio",
          "eurepo": "info:eu-repo/semantics/other",
          "subtype": "",
          "schema.org": "https://schema.org/MediaObject",
          "marc21_type": "audio",
          "datacite_type": "",
          "openaire_type": "dataset",
          "marc21_subtype": "",
          "datacite_general": "Sound",
          "openaire_resourceType": "0033"
        },
        "type": "resourcetypes"
      }
    ],
    "total": 1
  },
  "sortBy": "bestmatch",
  "links": {
    "self": "https://b2share.eudat.eu/api/vocabularies/resourcetypes?page=1&q=audio&size=25&sort=bestmatch"
  }
}

Get a vocabulary entry

Get a vocabulary entry

  HTTP method: GET

  URL path: /api/vocabularies/<vocabulary-id>/<entry-id>
  OR: /api/<vocabulary-id>/<entry-id>

  Required parameters: vocabulary-id, entry-id

  Status code on success: 200

  Returns: The vocabulary entry in JSON format.

Note! Some special vocabularies have their own endpoint on the api-root. These vocabularies are: awards, funders, affiliations, names, and subjects

Command:

curl "https://$B2SHARE_HOST/api/vocabularies/resourcetypes/audio"

Returns:

{
  "id": "audio",
  "created": "2025-10-24T12:11:24.266545+00:00",
  "updated": "2025-10-27T10:53:46.797246+00:00",
  "links": {
    "self": "https://b2share.eudat.eu/api/vocabularies/resourcetypes/audio"
  },
  "revision_id": 3,
  "title": {
    "cs": "Audio",
    "de": "Audio",
    "en": "Audio",
    "sv": "Audio"
  },
  "icon": "volume up",
  "tags": [
    "depositable",
    "linkable"
  ],
  "props": {
    "csl": "document",
    "type": "audio",
    "eurepo": "info:eu-repo/semantics/other",
    "subtype": "",
    "schema.org": "https://schema.org/MediaObject",
    "marc21_type": "audio",
    "datacite_type": "",
    "openaire_type": "dataset",
    "marc21_subtype": "",
    "datacite_general": "Sound",
    "openaire_resourceType": "0033"
  },
  "type": "resourcetypes"
}

Last update : 18.11.2025

Last review : 18.11.2025