### GET /installation/{key} Source: https://techdocs.gbif.org/en/openapi/v1/registry-principal-methods Get details of a single installation by its registry key. ```APIDOC ## GET /installation/{key} ### Description Get details of a single installation by its registry key. ### Method GET ### Endpoint /installation/{key} ### Parameters #### Path Parameters - **key** (string) - Required - The registry key of the installation. ### Response #### Success Response (200) The installation object. #### Response Example { "key": "string", "title": "string" } ``` -------------------------------- ### GET /installation Source: https://techdocs.gbif.org/en/openapi/v1/registry-principal-methods List all technical installations. ```APIDOC ## GET /installation ### Description List all technical installations registered in the GBIF Registry. ### Method GET ### Endpoint /installation ### Response #### Success Response (200) A list of installation objects. #### Response Example { "results": [ { "key": "string", "title": "string" } ] } ``` -------------------------------- ### GET /node/{key}/installation Source: https://techdocs.gbif.org/en/openapi/v1/registry List node's installations. ```APIDOC ## GET /node/{key}/installation ### Description List node's installations. ### Method GET ### Endpoint /node/{key}/installation ### Parameters #### Path Parameters - **key** (string) - Required - The node key. ``` -------------------------------- ### GET /installation/suggest Source: https://techdocs.gbif.org/en/openapi/v1/registry Provides installation suggestions based on query parameters. This is a convenience endpoint for autocomplete or search suggestions. ```APIDOC ## GET /installation/suggest ### Description Suggest installations. ### Method GET ### Endpoint /installation/suggest ### Response #### Success Response (200) Returns a list of suggested installations. ``` -------------------------------- ### GET /organization/{key}/installation Source: https://techdocs.gbif.org/en/openapi/v1/registry List organization's installations. ```APIDOC ## GET /organization/{key}/installation ### Description List organization's installations. ### Method GET ### Endpoint /organization/{key}/installation ### Parameters #### Path Parameters - **key** (string) - Required - The organization key. ``` -------------------------------- ### GET /installation/{key}/dataset Source: https://techdocs.gbif.org/en/openapi/v1/registry Lists all datasets served by a specific installation. This endpoint provides a way to discover datasets hosted by the installation. ```APIDOC ## GET /installation/{key}/dataset ### Description List installation's datasets. ### Method GET ### Endpoint /installation/{key}/dataset ### Parameters #### Path Parameters - **key** (string) - Required - The installation key. ### Response #### Success Response (200) Returns a list of datasets. ``` -------------------------------- ### GET /installation/{key}/contact Source: https://techdocs.gbif.org/en/openapi/v1/registry Retrieves all contacts associated with an installation. This returns a list of contact objects. ```APIDOC ## GET /installation/{key}/contact ### Description Retrieve all contacts of the record. ### Method GET ### Endpoint /installation/{key}/contact ### Parameters #### Path Parameters - **key** (string) - Required - The installation key. ### Response #### Success Response (200) Returns a list of contacts. ``` -------------------------------- ### GET /installation/deleted Source: https://techdocs.gbif.org/en/openapi/v1/registry List deleted installations. ```APIDOC ## GET /installation/deleted ### Description List deleted installations. ### Method GET ### Endpoint /installation/deleted ### Response #### Success Response (200) Returns a list of deleted installations. ``` -------------------------------- ### GET /installation/nonPublishing Source: https://techdocs.gbif.org/en/openapi/v1/registry List non-publishing installations. ```APIDOC ## GET /installation/nonPublishing ### Description List non-publishing installations. ### Method GET ### Endpoint /installation/nonPublishing ### Response #### Success Response (200) Returns a list of non-publishing installations. ``` -------------------------------- ### GET /installation/{key}/endpoint Source: https://techdocs.gbif.org/en/openapi/v1/registry Retrieves all endpoints associated with an installation. This returns a list of endpoint objects. ```APIDOC ## GET /installation/{key}/endpoint ### Description Retrieve all endpoints of the record. ### Method GET ### Endpoint /installation/{key}/endpoint ### Parameters #### Path Parameters - **key** (string) - Required - The installation key. ### Response #### Success Response (200) Returns a list of endpoints. ``` -------------------------------- ### POST /installation Source: https://techdocs.gbif.org/en/openapi/v1/registry Creates a new technical installation. The installation details are provided in the request body. ```APIDOC ## POST /installation ### Description Create a new installation. ### Method POST ### Endpoint /installation ### Request Body The installation object to create. ### Response #### Success Response (200) Returns the created installation. ``` -------------------------------- ### DELETE /installation/{key} Source: https://techdocs.gbif.org/en/openapi/v1/registry Deletes an installation. The deletion is logical, meaning the installation entry remains but gets a deleted timestamp. ```APIDOC ## DELETE /installation/{key} ### Description Delete an installation. ### Method DELETE ### Endpoint /installation/{key} ### Parameters #### Path Parameters - **key** (string) - Required - The installation key. ### Response #### Success Response (200) No content returned. ``` -------------------------------- ### GET /installation/{key}/comment Source: https://techdocs.gbif.org/en/openapi/v1/registry Retrieves all comments attached to an installation. This returns a list of comment objects. ```APIDOC ## GET /installation/{key}/comment ### Description Retrieve all comments of the record. ### Method GET ### Endpoint /installation/{key}/comment ### Parameters #### Path Parameters - **key** (string) - Required - The installation key. ### Response #### Success Response (200) Returns a list of comments. ``` -------------------------------- ### PUT /installation/{key} Source: https://techdocs.gbif.org/en/openapi/v1/registry Updates an existing installation. The updated installation details are provided in the request body. ```APIDOC ## PUT /installation/{key} ### Description Update an existing installation. ### Method PUT ### Endpoint /installation/{key} ### Parameters #### Path Parameters - **key** (string) - Required - The installation key. #### Request Body The updated installation object. ### Response #### Success Response (200) Returns the updated installation. ``` -------------------------------- ### GET /network/{key} Source: https://techdocs.gbif.org/en/openapi/v1/registry-principal-methods Get details of a single network by its registry key. ```APIDOC ## GET /network/{key} ### Description Get details of a single network by its registry key. ### Method GET ### Endpoint /network/{key} ### Parameters #### Path Parameters - **key** (string) - Required - The registry key of the network. ### Response #### Success Response (200) The network object. #### Response Example { "key": "string", "title": "string" } ``` -------------------------------- ### GET / Source: https://techdocs.gbif.org/en/openapi/v1/occurrence Home resource. ```APIDOC ## GET / ### Description Home resource. ### Method GET ### Endpoint / ``` -------------------------------- ### GET /dataset/{key}/process Source: https://techdocs.gbif.org/en/openapi/v1/registry Get details of all crawl attempts for a dataset. ```APIDOC ## GET /dataset/{key}/process ### Description Get details of all crawl attempts for a dataset. ### Method GET ### Endpoint /dataset/{key}/process ### Parameters #### Path Parameters - **key** (string) - Required - Dataset key ``` -------------------------------- ### GET /dataset/{key} Source: https://techdocs.gbif.org/en/openapi/v1/registry-principal-methods Get details of a single dataset by its registry key. ```APIDOC ## GET /dataset/{key} ### Description Get details of a single dataset by its registry key. ### Method GET ### Endpoint /dataset/{key} ### Parameters #### Path Parameters - **key** (string) - Required - The registry key of the dataset. ### Response #### Success Response (200) The dataset object. #### Response Example { "key": "string", "title": "string" } ``` -------------------------------- ### Example URLs for occurrence 2005380410 Source: https://techdocs.gbif.org/en/openapi/images These example URLs show how to access an occurrence image, with and without resizing parameters. The first URL returns the original size, the second requests a 200x200 crop. ```text https://api.gbif.org/v1/image/cache/occurrence/2005380410/media/568639b65b65ddb9090d3d6ef1abce14 ``` ```text https://api.gbif.org/v1/image/cache/200x/occurrence/2005380410/media/568639b65b65ddb9090d3d6ef1abce14 ``` -------------------------------- ### GET /dataset/suggest Source: https://techdocs.gbif.org/en/openapi/v1/registry Suggest datasets. ```APIDOC ## GET /dataset/suggest ### Description Suggest datasets. ### Method GET ### Endpoint /dataset/suggest ``` -------------------------------- ### GET /node/suggest Source: https://techdocs.gbif.org/en/openapi/v1/registry Suggest nodes. ```APIDOC ## GET /node/suggest ### Description Suggest nodes. ### Method GET ### Endpoint /node/suggest ``` -------------------------------- ### GET /vocabularies/{name}/releases/{version} Source: https://techdocs.gbif.org/en/openapi/v1/vocabulary Get details of a single vocabulary release. Retrieve information about a specific release version. ```APIDOC ## GET /vocabularies/{name}/releases/{version} ### Description Get details of a single vocabulary release. ### Method GET ### Endpoint /vocabularies/{name}/releases/{version} ### Parameters #### Path Parameters - **name** (string) - Required - The name of the vocabulary. - **version** (string) - Required - The release version. ### Response #### Success Response (200) - The release details. ``` -------------------------------- ### GET /vocabularies/{name}/releases/{version}/export Source: https://techdocs.gbif.org/en/openapi/v1/vocabulary Get the exported release. Downloads the exported content of a specific release. ```APIDOC ## GET /vocabularies/{name}/releases/{version}/export ### Description Get the exported release. ### Method GET ### Endpoint /vocabularies/{name}/releases/{version}/export ### Parameters #### Path Parameters - **name** (string) - Required - The name of the vocabulary. - **version** (string) - Required - The release version. ### Response #### Success Response (200) - The exported release file. ``` -------------------------------- ### GET /dataset/{key}/process/{attempt} Source: https://techdocs.gbif.org/en/openapi/v1/registry Get details of a particular crawl attempt for the dataset. ```APIDOC ## GET /dataset/{key}/process/{attempt} ### Description Get details of a particular crawl attempt for the dataset. ### Method GET ### Endpoint /dataset/{key}/process/{attempt} ### Parameters #### Path Parameters - **key** (string) - Required - Dataset key - **attempt** (string) - Required - Attempt number ``` -------------------------------- ### GET /node Source: https://techdocs.gbif.org/en/openapi/v1/registry-principal-methods List all nodes. ```APIDOC ## GET /node ### Description List all nodes registered in the GBIF Registry. ### Method GET ### Endpoint /node ### Response #### Success Response (200) A list of node objects. #### Response Example { "results": [ { "key": "string", "title": "string" } ] } ``` -------------------------------- ### GET /network Source: https://techdocs.gbif.org/en/openapi/v1/registry-principal-methods List all networks. ```APIDOC ## GET /network ### Description List all networks registered in the GBIF Registry. ### Method GET ### Endpoint /network ### Response #### Success Response (200) A list of network objects. #### Response Example { "results": [ { "key": "string", "title": "string" } ] } ``` -------------------------------- ### GET /vocabularies/{name}/definition/{key} Source: https://techdocs.gbif.org/en/openapi/v1/vocabulary Get the definition of a vocabulary. Retrieves a specific definition by its key. ```APIDOC ## GET /vocabularies/{name}/definition/{key} ### Description Get the definition of a vocabulary. ### Method GET ### Endpoint /vocabularies/{name}/definition/{key} ### Parameters #### Path Parameters - **name** (string) - Required - The name of the vocabulary. - **key** (string) - Required - The key of the definition. ### Response #### Success Response (200) - The definition details. ``` -------------------------------- ### GET /organization/{key} Source: https://techdocs.gbif.org/en/openapi/v1/registry-principal-methods Get details of a single publishing organization by its registry key. ```APIDOC ## GET /organization/{key} ### Description Get details of a single publishing organization by its registry key. ### Method GET ### Endpoint /organization/{key} ### Parameters #### Path Parameters - **key** (string) - Required - The registry key of the organization. ### Response #### Success Response (200) The organization object. #### Response Example { "key": "string", "title": "string" } ``` -------------------------------- ### GET /vocabularies/{vocabularyName}/concepts/{name}/definition/{key} Source: https://techdocs.gbif.org/en/openapi/v1/vocabulary Get the definition of a concept. Retrieves a specific definition by its key. ```APIDOC ## GET /vocabularies/{vocabularyName}/concepts/{name}/definition/{key} ### Description Get the definition of a concept. ### Method GET ### Endpoint /vocabularies/{vocabularyName}/concepts/{name}/definition/{key} ### Parameters #### Path Parameters - **vocabularyName** (string) - Required - The name of the vocabulary. - **name** (string) - Required - The name of the concept. - **key** (string) - Required - The key of the definition. ### Response #### Success Response (200) - The definition details. ``` -------------------------------- ### GET /grscicoll/collection/suggest Source: https://techdocs.gbif.org/en/openapi/v1/registry Suggest collections. ```APIDOC ## GET /grscicoll/collection/suggest ### Description Suggest collections. ### Method GET ### Endpoint /grscicoll/collection/suggest ### Query Parameters - **q** (string) - Optional - Search query ### Response #### Success Response (200) Returns a list of suggested collections. ``` -------------------------------- ### GET /vocabularyTags Source: https://techdocs.gbif.org/en/openapi/v1/vocabulary List all tags. ```APIDOC ## GET /vocabularyTags ### Description List all tags. ### Method GET ### Endpoint /vocabularyTags ### Response #### Success Response (200) - **tags** (array) - List of tags. #### Response Example ```json { "tags": ["tag1", "tag2"] } ``` ``` -------------------------------- ### GET /organization/suggest Source: https://techdocs.gbif.org/en/openapi/v1/registry Suggest organizations. ```APIDOC ## GET /organization/suggest ### Description Suggest organizations. ### Method GET ### Endpoint /organization/suggest ``` -------------------------------- ### GET /occurrence/search/samplingProtocol Source: https://techdocs.gbif.org/en/openapi/v1/occurrence Suggests sampling protocols. ```APIDOC ## GET /occurrence/search/samplingProtocol ### Description Suggests sampling protocols. ### Method GET ### Endpoint /occurrence/search/samplingProtocol ### Response #### Success Response (200) Returns a list of suggested sampling protocols. #### Response Example { "suggestions": [] } ``` -------------------------------- ### GET /occurrence/download/statistics/downloadsByDataset Source: https://techdocs.gbif.org/en/openapi/v1/occurrence Summarize downloads by dataset. ```APIDOC ## GET /occurrence/download/statistics/downloadsByDataset ### Description Summarize downloads by dataset. ### Method GET ### Endpoint /occurrence/download/statistics/downloadsByDataset ``` -------------------------------- ### POST /installation/{key}/tag Source: https://techdocs.gbif.org/en/openapi/v1/registry Add a tag to the record. ```APIDOC ## POST /installation/{key}/tag ### Description Add a tag to the record. ### Method POST ### Endpoint /installation/{key}/tag ### Parameters #### Path Parameters - **key** - Required - The installation key #### Request Body - **name** (string) - Required - The tag name ### Response #### Success Response (200) The tag was added successfully. #### Response Example ```json { "key": "string", "name": "string" } ``` ``` -------------------------------- ### GET /installation/{key}/tag Source: https://techdocs.gbif.org/en/openapi/v1/registry Retrieve all tags of the record. ```APIDOC ## GET /installation/{key}/tag ### Description Retrieve all tags of the record. ### Method GET ### Endpoint /installation/{key}/tag ### Parameters #### Path Parameters - **key** - Required - The installation key ### Response #### Success Response (200) Returns a list of tags. #### Response Example ```json [ { "key": "string", "name": "string" } ] ``` ``` -------------------------------- ### POST /installation/{key}/comment Source: https://techdocs.gbif.org/en/openapi/v1/registry Adds a comment to an installation. The comment details are provided in the request body. ```APIDOC ## POST /installation/{key}/comment ### Description Add a comment to the record. ### Method POST ### Endpoint /installation/{key}/comment ### Parameters #### Path Parameters - **key** (string) - Required - The installation key. #### Request Body The comment object to add. ### Response #### Success Response (200) No content returned. ``` -------------------------------- ### POST /installation/{key}/contact Source: https://techdocs.gbif.org/en/openapi/v1/registry Adds a new contact to an installation. The contact details are provided in the request body. ```APIDOC ## POST /installation/{key}/contact ### Description Add a contact to the record. ### Method POST ### Endpoint /installation/{key}/contact ### Parameters #### Path Parameters - **key** (string) - Required - The installation key. #### Request Body The contact object to add. ### Response #### Success Response (200) No content returned. ``` -------------------------------- ### GET /node/country/{countryCode} Source: https://techdocs.gbif.org/en/openapi/v1/registry Get the node for a country. ```APIDOC ## GET /node/country/{countryCode} ### Description Get the node for a country. ### Method GET ### Endpoint /node/country/{countryCode} ### Parameters #### Path Parameters - **countryCode** (string) - Required - The country code. ``` -------------------------------- ### GET /vocabularyTags/{name} Source: https://techdocs.gbif.org/en/openapi/v1/vocabulary Get details of a single tag. ```APIDOC ## GET /vocabularyTags/{name} ### Description Get details of a single tag. ### Method GET ### Endpoint /vocabularyTags/{name} ### Parameters #### Path Parameters - **name** (string) - Required - The name of the tag. ### Response #### Success Response (200) - **tag** (object) - The tag details. #### Response Example ```json { "tag": {} } ``` ``` -------------------------------- ### GET /grscicoll/collection/{collectionKey}/descriptorGroup/suggestion/{key} Source: https://techdocs.gbif.org/en/openapi/v1/registry Get a descriptor change suggestion. ```APIDOC ## GET /grscicoll/collection/{collectionKey}/descriptorGroup/suggestion/{key} ### Description Get a descriptor change suggestion. ### Method GET ### Endpoint /grscicoll/collection/{collectionKey}/descriptorGroup/suggestion/{key} ### Parameters #### Path Parameters - **collectionKey** - Required - The collection key - **key** - Required - The suggestion key ### Response #### Success Response (200) Returns the descriptor change suggestion. ``` -------------------------------- ### POST /installation/{key}/identifier Source: https://techdocs.gbif.org/en/openapi/v1/registry Add an identifier to the record. ```APIDOC ## POST /installation/{key}/identifier ### Description Add an identifier to the record. ### Method POST ### Endpoint /installation/{key}/identifier ### Parameters #### Path Parameters - **key** - Required - The installation key #### Request Body - **identifier** (string) - Required - The identifier to add - **type** (string) - Required - The type of identifier ### Response #### Success Response (200) The identifier was added successfully. #### Response Example ```json { "key": "string", "identifier": "string", "type": "string" } ``` ``` -------------------------------- ### POST /installation/{key}/endpoint Source: https://techdocs.gbif.org/en/openapi/v1/registry Adds a new endpoint to an installation. The endpoint details are provided in the request body. ```APIDOC ## POST /installation/{key}/endpoint ### Description Add an endpoint to the record. ### Method POST ### Endpoint /installation/{key}/endpoint ### Parameters #### Path Parameters - **key** (string) - Required - The installation key. #### Request Body The endpoint object to add. ### Response #### Success Response (200) No content returned. ``` -------------------------------- ### GET /node/{key} Source: https://techdocs.gbif.org/en/openapi/v1/registry-principal-methods Get details of a single node by its registry key. ```APIDOC ## GET /node/{key} ### Description Get details of a single node by its registry key. ### Method GET ### Endpoint /node/{key} ### Parameters #### Path Parameters - **key** (string) - Required - The registry key of the node. ### Response #### Success Response (200) The node object. #### Response Example { "key": "string", "title": "string" } ``` -------------------------------- ### GET /installation/{key}/identifier Source: https://techdocs.gbif.org/en/openapi/v1/registry Retrieve all identifiers of the record. ```APIDOC ## GET /installation/{key}/identifier ### Description Retrieve all identifiers of the record. ### Method GET ### Endpoint /installation/{key}/identifier ### Parameters #### Path Parameters - **key** - Required - The installation key ### Response #### Success Response (200) Returns a list of identifiers. #### Response Example ```json [ { "key": "string", "identifier": "string", "type": "string" } ] ``` ``` -------------------------------- ### GET /grscicoll/collection/latimerCore/{key} Source: https://techdocs.gbif.org/en/openapi/v1/registry Get details of a single collection in Latimer Core format. ```APIDOC ## GET /grscicoll/collection/latimerCore/{key} ### Description Get details of a single collection in Latimer Core format. ### Method GET ### Endpoint /grscicoll/collection/latimerCore/{key} ### Parameters #### Path Parameters - **key** - Required - The collection key ### Response #### Success Response (200) Returns the collection details in Latimer Core format. ``` -------------------------------- ### GET /installation/{key}/machineTag Source: https://techdocs.gbif.org/en/openapi/v1/registry List all machine tags on the record. ```APIDOC ## GET /installation/{key}/machineTag ### Description List all machine tags on the record. ### Method GET ### Endpoint /installation/{key}/machineTag ### Parameters #### Path Parameters - **key** - Required - The installation key ### Response #### Success Response (200) Returns a list of machine tags. #### Response Example ```json [ { "key": "string", "namespace": "string", "name": "string", "value": "string" } ] ``` ``` -------------------------------- ### PUT /installation/{key}/contact Source: https://techdocs.gbif.org/en/openapi/v1/registry Updates an existing contact on an installation. This replaces the contact information. ```APIDOC ## PUT /installation/{key}/contact ### Description Update an existing contact on the record. ### Method PUT ### Endpoint /installation/{key}/contact ### Parameters #### Path Parameters - **key** (string) - Required - The installation key. #### Request Body The updated contact object. ### Response #### Success Response (200) No content returned. ``` -------------------------------- ### POST /installation/{key}/machineTag Source: https://techdocs.gbif.org/en/openapi/v1/registry Add a machine tag to the record. ```APIDOC ## POST /installation/{key}/machineTag ### Description Add a machine tag to the record. ### Method POST ### Endpoint /installation/{key}/machineTag ### Parameters #### Path Parameters - **key** - Required - The installation key #### Request Body - **namespace** (string) - Required - The namespace of the machine tag - **name** (string) - Required - The name of the machine tag - **value** (string) - Required - The value of the machine tag ### Response #### Success Response (200) The machine tag was added successfully. #### Response Example ```json { "key": "string", "namespace": "string", "name": "string", "value": "string" } ``` ``` -------------------------------- ### GET /vocabularies/{name} Source: https://techdocs.gbif.org/en/openapi/v1/vocabulary Get details of a single vocabulary. Retrieve information about a specific vocabulary by its name. ```APIDOC ## GET /vocabularies/{name} ### Description Get details of a single vocabulary. ### Method GET ### Endpoint /vocabularies/{name} ### Parameters #### Path Parameters - **name** (string) - Required - The name of the vocabulary. ### Response #### Success Response (200) - The vocabulary details. ``` -------------------------------- ### PUT /installation/{key}/contact/{contactKey} Source: https://techdocs.gbif.org/en/openapi/v1/registry Updates a specific contact on an installation by its contact key. This replaces the contact information for that contact. ```APIDOC ## PUT /installation/{key}/contact/{contactKey} ### Description Update an existing contact on the record. ### Method PUT ### Endpoint /installation/{key}/contact/{contactKey} ### Parameters #### Path Parameters - **key** (string) - Required - The installation key. - **contactKey** (string) - Required - The contact key to update. #### Request Body The updated contact object. ### Response #### Success Response (200) No content returned. ``` -------------------------------- ### GET /vocabularies/{vocabularyName}/concepts/{name} Source: https://techdocs.gbif.org/en/openapi/v1/vocabulary Get details of a single concept. Retrieve a specific concept by its name. ```APIDOC ## GET /vocabularies/{vocabularyName}/concepts/{name} ### Description Get details of a single concept. ### Method GET ### Endpoint /vocabularies/{vocabularyName}/concepts/{name} ### Parameters #### Path Parameters - **vocabularyName** (string) - Required - The name of the vocabulary. - **name** (string) - Required - The name of the concept. ### Response #### Success Response (200) - The concept details. ``` -------------------------------- ### GET /enumeration/license Source: https://techdocs.gbif.org/en/openapi/v2 Lists all supported GBIF licenses using the License URL or just the enum name if no URL exists. ```APIDOC ## GET /enumeration/license ### Description Lists all supported GBIF licenses using the License URL or just the enum name if no URL exists. ### Method GET ### Endpoint /enumeration/license ### Response #### Success Response (200) - **body** (License list) - List of supported licenses. #### Response Example ```json ["CC0_1_0", "CC_BY_4_0"] ``` ``` -------------------------------- ### GET /occurrence/experimental/multimedia/species/{checklistKey}/{taxonKey} Source: https://techdocs.gbif.org/en/openapi/v1/occurrence Occurrence species multimedia resource. ```APIDOC ## GET /occurrence/experimental/multimedia/species/{checklistKey}/{taxonKey} ### Description Occurrence species multimedia resource. ### Method GET ### Endpoint /occurrence/experimental/multimedia/species/{checklistKey}/{taxonKey} ``` -------------------------------- ### GET /enumeration/basic/{ENUMERATION} Source: https://techdocs.gbif.org/en/openapi/v2 Lists all available values for a given enumeration. ```APIDOC ## GET /enumeration/basic/{ENUMERATION} ### Description Lists all available values for a given enumeration. ### Method GET ### Endpoint /enumeration/basic/{ENUMERATION} ### Parameters #### Path Parameters - **ENUMERATION** (string) - Required - The name of the enumeration. ### Response #### Success Response (200) - **body** (Enumeration values) - List of all available values for the enumeration. #### Response Example ```json ["value1", "value2"] ``` ``` -------------------------------- ### GET /grscicoll/institution/{key} Source: https://techdocs.gbif.org/en/openapi/v1/registry-principal-methods Get details of a single institution. This endpoint retrieves the full details of a specific institution identified by its key. ```APIDOC ## GET /grscicoll/institution/{key} ### Description Get details of a single institution. ### Method GET ### Endpoint /grscicoll/institution/{key} ### Parameters #### Path Parameters - **key** (string) - Required - The unique identifier of the institution. ``` -------------------------------- ### GET /grscicoll/collection/{key} Source: https://techdocs.gbif.org/en/openapi/v1/registry-principal-methods Get details of a single collection. This endpoint retrieves the full details of a specific collection identified by its key. ```APIDOC ## GET /grscicoll/collection/{key} ### Description Get details of a single collection. ### Method GET ### Endpoint /grscicoll/collection/{key} ### Parameters #### Path Parameters - **key** (string) - Required - The unique identifier of the collection. ``` -------------------------------- ### POST /organization Source: https://techdocs.gbif.org/en/openapi/v1/registry Create a new publishing organization. ```APIDOC ## POST /organization ### Description Create a new publishing organization. ### Method POST ### Endpoint /organization ``` -------------------------------- ### GET /vocabularies/{vocabularyName}/concepts/latestRelease/{name}/definition Source: https://techdocs.gbif.org/en/openapi/v1/vocabulary Get the definition of a concept from the latest release. Retrieves the definition of a concept from the latest release. ```APIDOC ## GET /vocabularies/{vocabularyName}/concepts/latestRelease/{name}/definition ### Description Get the definition of a concept from the latest release. ### Method GET ### Endpoint /vocabularies/{vocabularyName}/concepts/latestRelease/{name}/definition ### Parameters #### Path Parameters - **vocabularyName** (string) - Required - The name of the vocabulary. - **name** (string) - Required - The name of the concept. ### Response #### Success Response (200) - The definition details. ``` -------------------------------- ### GET /vocabularies/{vocabularyName}/concepts/latestRelease/{name} Source: https://techdocs.gbif.org/en/openapi/v1/vocabulary Get details of a single concept from the latest release of the vocabulary. Retrieves a specific concept from the latest release. ```APIDOC ## GET /vocabularies/{vocabularyName}/concepts/latestRelease/{name} ### Description Get details of a single concept from the latest release of the vocabulary. ### Method GET ### Endpoint /vocabularies/{vocabularyName}/concepts/latestRelease/{name} ### Parameters #### Path Parameters - **vocabularyName** (string) - Required - The name of the vocabulary. - **name** (string) - Required - The name of the concept. ### Response #### Success Response (200) - The concept details. ``` -------------------------------- ### GET /enumeration/basic Source: https://techdocs.gbif.org/en/openapi/v2 Lists all available enumerations used in the GBIF API. ```APIDOC ## GET /enumeration/basic ### Description Lists all available enumerations used in the GBIF API. ### Method GET ### Endpoint /enumeration/basic ### Response #### Success Response (200) - **body** (Enumeration list) - List of all available enumerations. #### Response Example ```json ["enumeration1", "enumeration2"] ``` ``` -------------------------------- ### GET /v1/species/{usageKey}/media Source: https://techdocs.gbif.org/en/openapi/v1/species Retrieve media for a name usage by usage key. Returns media items (images, sounds, etc.) associated with the taxon. ```APIDOC ## GET /v1/species/{usageKey}/media ### Description Retrieve media for a name usage by usage key. Returns media items (images, sounds, etc.) associated with the taxon. ### Method GET ### Endpoint /v1/species/{usageKey}/media ### Parameters #### Path Parameters - **usageKey** (string) - Required - The usage key of the name usage. ### Response #### Success Response (200) Returns a list of media items. ``` -------------------------------- ### POST /dataset Source: https://techdocs.gbif.org/en/openapi/v1/registry Create a new dataset in the Registry. ```APIDOC ## POST /dataset ### Description Create a new dataset in the Registry. ### Method POST ### Endpoint /dataset ``` -------------------------------- ### GET /occurrence/experimental/multimedia/species/{taxonKey} Source: https://techdocs.gbif.org/en/openapi/v1/occurrence Occurrence species multimedia resource. ```APIDOC ## GET /occurrence/experimental/multimedia/species/{taxonKey} ### Description Occurrence species multimedia resource. ### Method GET ### Endpoint /occurrence/experimental/multimedia/species/{taxonKey} ``` -------------------------------- ### GET /occurrence/count Source: https://techdocs.gbif.org/en/openapi/v1/occurrence Occurrence counts. ```APIDOC ## GET /occurrence/count ### Description Occurrence counts. ### Method GET ### Endpoint /occurrence/count ``` -------------------------------- ### POST /occurrence/download/request Source: https://techdocs.gbif.org/en/openapi/v1/occurrence Requests the creation of a download file. ```APIDOC ## POST /occurrence/download/request ### Description Requests the creation of a download file. Requires user registration and HTTP authentication. ### Method POST ### Endpoint /occurrence/download/request ### Request Body - **predicate** (object) - Required - The predicate defining the download. ### Response #### Success Response (200) Returns the download request key. #### Response Example { "key": "0001234-1234" } ``` -------------------------------- ### GET /occurrence/search/stateProvince Source: https://techdocs.gbif.org/en/openapi/v1/occurrence Suggests states/provinces. ```APIDOC ## GET /occurrence/search/stateProvince ### Description Suggests states/provinces. ### Method GET ### Endpoint /occurrence/search/stateProvince ### Response #### Success Response (200) Returns a list of suggested states/provinces. #### Response Example { "suggestions": [] } ``` -------------------------------- ### GET /occurrence/download/request/sql Source: https://techdocs.gbif.org/en/openapi/v1/occurrence Converts a plain search query into an SQL download predicate. ```APIDOC ## GET /occurrence/download/request/sql ### Description Converts a plain search query into an SQL download predicate. ### Method GET ### Endpoint /occurrence/download/request/sql ``` -------------------------------- ### GET /occurrence/download/request/{key} Source: https://techdocs.gbif.org/en/openapi/v1/occurrence Retrieves the resulting download file. ```APIDOC ## GET /occurrence/download/request/{key} ### Description Retrieves the resulting download file. ### Method GET ### Endpoint /occurrence/download/request/{key} ### Parameters #### Path Parameters - **key** (string) - Required - The download request key. ### Response #### Success Response (200) Returns the download file. #### Response Example { "key": "0001234-1234" } ``` -------------------------------- ### POST /occurrence/download/request/sql Source: https://techdocs.gbif.org/en/openapi/v1/occurrence Converts a predicate download request into an SQL download request. ```APIDOC ## POST /occurrence/download/request/sql ### Description Converts a predicate download request into an SQL download request. ### Method POST ### Endpoint /occurrence/download/request/sql ``` -------------------------------- ### GET /vocabularyLanguage Source: https://techdocs.gbif.org/en/openapi/v1/vocabulary List all languages. ```APIDOC ## GET /vocabularyLanguage ### Description List all languages. ### Method GET ### Endpoint /vocabularyLanguage ### Response #### Success Response (200) - **languages** (array) - List of languages. #### Response Example ```json { "languages": ["en", "fr"] } ``` ``` -------------------------------- ### GET /organization/geojson Source: https://techdocs.gbif.org/en/openapi/v1/registry List all organizations as GeoJson. ```APIDOC ## GET /organization/geojson ### Description List all organizations as GeoJson. ### Method GET ### Endpoint /organization/geojson ``` -------------------------------- ### GET /dataset/{key}/metrics Source: https://techdocs.gbif.org/en/openapi/v1/registry Checklist dataset metrics. ```APIDOC ## GET /dataset/{key}/metrics ### Description Checklist dataset metrics. ### Method GET ### Endpoint /dataset/{key}/metrics ### Parameters #### Path Parameters - **key** (string) - Required - Dataset key ``` -------------------------------- ### GET /occurrence/download/describe/sql Source: https://techdocs.gbif.org/en/openapi/v1/occurrence Describes the fields available for searching or download when using an SQL query. This endpoint is very experimental. ```APIDOC ## GET /occurrence/download/describe/sql ### Description Describes the fields available for searching or download when using an SQL query. This endpoint is very experimental. ### Method GET ### Endpoint /occurrence/download/describe/sql ``` -------------------------------- ### GET /organization/nonPublishing Source: https://techdocs.gbif.org/en/openapi/v1/registry List non-publishing organizations. ```APIDOC ## GET /organization/nonPublishing ### Description List non-publishing organizations. ### Method GET ### Endpoint /organization/nonPublishing ``` -------------------------------- ### GET /grscicoll/collection/{collectionKey}/descriptorGroup/suggestion/{key}/file Source: https://techdocs.gbif.org/en/openapi/v1/registry Export a descriptor suggestion file. ```APIDOC ## GET /grscicoll/collection/{collectionKey}/descriptorGroup/suggestion/{key}/file ### Description Export a descriptor suggestion file. ### Method GET ### Endpoint /grscicoll/collection/{collectionKey}/descriptorGroup/suggestion/{key}/file ### Parameters #### Path Parameters - **collectionKey** - Required - The collection key - **key** - Required - The suggestion key ### Response #### Success Response (200) Returns the descriptor suggestion file. ``` -------------------------------- ### GET /organization/pending Source: https://techdocs.gbif.org/en/openapi/v1/registry List pending organizations. ```APIDOC ## GET /organization/pending ### Description List pending organizations. ### Method GET ### Endpoint /organization/pending ``` -------------------------------- ### POST /network Source: https://techdocs.gbif.org/en/openapi/v1/registry Creates a new network. The network details are provided in the request body. ```APIDOC ## POST /network ### Description Creates a new network. ### Method POST ### Endpoint /network ### Request Body The network object to create. ### Response #### Success Response (200) Returns the created network. ``` -------------------------------- ### GET /organization/deleted Source: https://techdocs.gbif.org/en/openapi/v1/registry List deleted organizations. ```APIDOC ## GET /organization/deleted ### Description List deleted organizations. ### Method GET ### Endpoint /organization/deleted ``` -------------------------------- ### GET /occurrence/download/describe/simpleAvro Source: https://techdocs.gbif.org/en/openapi/v1/occurrence Describes the fields present in a Simple Avro format download. This endpoint is experimental. ```APIDOC ## GET /occurrence/download/describe/simpleAvro ### Description Describes the fields present in a Simple Avro format download. This endpoint is experimental. ### Method GET ### Endpoint /occurrence/download/describe/simpleAvro ``` -------------------------------- ### GET /dataset/withNoEndpoint Source: https://techdocs.gbif.org/en/openapi/v1/registry List all datasets with no endpoint. ```APIDOC ## GET /dataset/withNoEndpoint ### Description List all datasets with no endpoint. ### Method GET ### Endpoint /dataset/withNoEndpoint ```