OSF

OSF GUIDs API

The GUIDs API from OSF — 1 operation(s) for guids.

Operations 1

GET /guids/{guid_id}/ Retrieve a GUID resource or redirect to its referent resource #

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/osf:osf-guids-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

osf-guids-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: OSF APIv2 Documentation GUIDs API
  description: This is the official documentation for the OSF (Open Science Framework) API v2.
  version: '2.0'
  termsOfService: https://osf.io/terms_of_use/
  contact:
    name: OSF Support Team
    email: support@osf.io
    url: https://help.osf.io/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://cdn.cos.io/media/images/cos_center_logo_small.original.png
    backgroundColor: transparent
servers:
- url: https://api.test.osf.io/v2
tags:
- name: GUIDs
paths:
  /guids/{guid_id}/:
    get:
      summary: Retrieve a GUID resource or redirect to its referent resource
      description: 'Retrieve a GUID object or be redirected to the most appropriate resource.


        By default, this endpoint redirects (`302 Found`) to the resource URL associated with the GUID.

        If `?resolve=false` is passed, it returns the GUID resource object instead of redirecting.


        GUIDs may reference nodes, registrations, files, collections, preprints, or users.


        ### Redirect Behavior

        - If the GUID refers to a supported resource, this will redirect to its detail endpoint.

        - If it refers to an unsupported type (e.g., wiki), `501 Not Implemented` is returned.

        - If the GUID is invalid or deleted, a `404` or `410` is returned.


        ### JSON Response Behavior

        - If `resolve=false` is used, a `200 OK` is returned with the GUID resource object.


        ### Permissions

        - Public GUIDs are accessible without authentication.

        - Private GUIDs require appropriate access permissions.'
      operationId: retrieveGuid
      tags:
      - GUIDs
      parameters:
      - name: guid_id
        in: path
        required: true
        description: The unique identifier for the GUID.
        schema:
          type: string
      - name: resolve
        in: query
        required: false
        description: 'If true (default), redirect to the referent resource.

          If false, return a representation of the GUID resource.

          '
        schema:
          type: boolean
      responses:
        '200':
          description: Successfully retrieved the GUID resource.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    required:
                    - id
                    - type
                    - attributes
                    - relationships
                    - links
                    properties:
                      id:
                        type: string
                        description: The GUID string.
                        example: abc123
                      type:
                        type: string
                        description: The type of this resource.
                        example: guids
                      attributes:
                        type: object
                        description: Optional metadata (usually empty).
                        example: {}
                      relationships:
                        type: object
                        properties:
                          referent:
                            type: object
                            description: The resource this GUID points to.
                            properties:
                              links:
                                type: object
                                properties:
                                  related:
                                    type: string
                                    example: https://api.osf.io/v2/nodes/abc123/
                              meta:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    description: Resource type of the referent.
                                    example: nodes
                          custom_metadata:
                            type: object
                            description: Link to any associated custom metadata record.
                            properties:
                              links:
                                type: object
                                properties:
                                  related:
                                    type: string
                                    example: https://api.osf.io/v2/custom_file_metadata_records/abc123/
                      links:
                        type: object
                        properties:
                          self:
                            type: string
                            example: https://api.osf.io/v2/guids/abc123/
                            description: API link to this GUID resource.
                          html:
                            type: string
                            example: https://osf.io/abc123/
                            description: Public web URL of this resource.
        '302':
          description: Redirects to the referent resource if `resolve=true` or omitted.
        '401':
          description: Authentication required.
        '403':
          description: You do not have permission to view this GUID.
        '404':
          description: GUID not found.
        '410':
          description: The GUID has been deleted.
x-tagGroups:
- name: Welcome
  tags:
  - Introduction
  - General Usage
  - Authentication
  - Pagination
  - Versioning
  - Filtering
  - Sparse Fieldsets
  - Embedding
  - Request Formatting
  - Errors & Error Codes
  - Entities & Entity Collections
- name: API Reference
  tags:
  - Actions
  - Addons
  - Applications
  - Base
  - CEDAR Metadata
  - Citations
  - Comments
  - Collections
  - Collection Submissions
  - Collection Submissions Actions
  - Collection Providers
  - Custom Metadata
  - Files
  - Licenses
  - Logs
  - Institutions
  - Identifiers
  - Registration Schemas
  - Registration Schema Blocks
  - Schema Responses
  - Schema Response Actions
  - Nodes
  - Notification Subscriptions
  - Preprints
  - Preprint Providers
  - Draft Registrations
  - Registrations
  - Registration Providers
  - Regions
  - OAuth Scopes
  - Taxonomies
  - Tokens
  - Users
  - View Only Links
  - Wikis
  - Subjects
  - GUIDs
  - Requests
  - Resources