OSF APIv2 Documentation

osf · Data

Data No Auth Free & Open open_data

OSF APIv2 Documentation API

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Root

#### Returns A JSON object with `meta` and `links` keys. The `meta` key contains information such as a welcome message from the API, the specified version of the request, and the full representation of the current user, if authentication credentials were provided in the request. The `links` key co

https://api.apis.guru/v2/specs/osf.io/2.0

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/osf.io/2.0/"

import requests
response = requests.get(
    "https://api.apis.guru/v2/specs/osf.io/2.0/",
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/osf.io/2.0/';

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/osf.io/2.0/"
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/osf.io/2.0/")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/osf.io/2.0/";
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Actions

A log can have one of many actions. The complete list of loggable actions (in the format {identifier}: {description}) is as follows: * `project_created`: A Node is created * `project_registered`: A Node is registered * `project_deleted`: A Node is deleted * `created_from`: A Node is created using a

https://api.apis.guru/v2/specs/osf.io/2.0/actions

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/osf.io/2.0/actions/"

import requests
response = requests.get(
    "https://api.apis.guru/v2/specs/osf.io/2.0/actions/",
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/osf.io/2.0/actions/';

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/osf.io/2.0/actions/"
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/osf.io/2.0/actions/")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/osf.io/2.0/actions/";
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET List all addons

A paginated list of addons configurable with the OSF, for read purposes only. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 addons. Each resource in the array is a separate addon object. The `links` key contains a dictionary of

https://api.apis.guru/v2/specs/osf.io/2.0/addons

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/osf.io/2.0/addons/"

import requests
response = requests.get(
    "https://api.apis.guru/v2/specs/osf.io/2.0/addons/",
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/osf.io/2.0/addons/';

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/osf.io/2.0/addons/"
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/osf.io/2.0/addons/")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/osf.io/2.0/addons/";
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with OSF APIv2 Documentation?

OSF APIv2 Documentation is a Data API. Developers commonly use data APIs for:

enriching your app with third-party datasets
building data pipelines and ETL workflows
querying and searching large datasets
powering research, analysis, and reporting tools
syncing reference data into your own systems

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. OSF APIv2 Documentation is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide

Open documentation ↗