{
  "opencollection": "1.0.0",
  "info": {
    "name": "Figshare altmetric projects API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "projects",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Public Projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/projects",
            "headers": [
              {
                "name": "X-Cursor",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. Used for pagination with page_size"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of results included on a page. Used for pagination with page"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results included on a page. Used for pagination with query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Where to start the listing (the offset of the first result). Used for pagination with limit"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The field by which to order. Default varies by endpoint/resource."
              },
              {
                "name": "order_direction",
                "value": "",
                "type": "query"
              },
              {
                "name": "institution",
                "value": "",
                "type": "query",
                "description": "only return collections from this institution"
              },
              {
                "name": "published_since",
                "value": "",
                "type": "query",
                "description": "Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD"
              },
              {
                "name": "group",
                "value": "",
                "type": "query",
                "description": "only return collections from this group"
              }
            ]
          },
          "docs": "Returns a list of public projects"
        },
        {
          "info": {
            "name": "Public Projects Search",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.figshare.com/v2/projects/search",
            "headers": [
              {
                "name": "X-Cursor",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Returns a list of public articles"
        },
        {
          "info": {
            "name": "Public Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/projects/:project_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project Unique identifier"
              }
            ]
          },
          "docs": "View a project"
        },
        {
          "info": {
            "name": "Public Project Articles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/projects/:project_id/articles",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project Unique identifier"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. Used for pagination with page_size"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of results included on a page. Used for pagination with page"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results included on a page. Used for pagination with query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Where to start the listing (the offset of the first result). Used for pagination with limit"
              }
            ]
          },
          "docs": "List articles in project"
        },
        {
          "info": {
            "name": "Private Projects search",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.figshare.com/v2/account/projects/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search inside the private projects"
        },
        {
          "info": {
            "name": "Private Projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/account/projects",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. Used for pagination with page_size"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of results included on a page. Used for pagination with page"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results included on a page. Used for pagination with query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Where to start the listing (the offset of the first result). Used for pagination with limit"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The field by which to order."
              },
              {
                "name": "order_direction",
                "value": "",
                "type": "query"
              },
              {
                "name": "storage",
                "value": "",
                "type": "query",
                "description": "only return collections from this institution"
              },
              {
                "name": "roles",
                "value": "",
                "type": "query",
                "description": "Any combination of owner, collaborator, viewer separated by comma. Examples: \"owner\" or \"owner,collaborator\"."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "List private projects"
        },
        {
          "info": {
            "name": "Create project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.figshare.com/v2/account/projects",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a new project"
        },
        {
          "info": {
            "name": "View project details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/account/projects/:project_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "View a private project"
        },
        {
          "info": {
            "name": "Update project",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.figshare.com/v2/account/projects/:project_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updating an project by passing body parameters."
        },
        {
          "info": {
            "name": "Partially update project",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.figshare.com/v2/account/projects/:project_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Partially update a project; only provided fields will be changed."
        },
        {
          "info": {
            "name": "Delete project",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.figshare.com/v2/account/projects/:project_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "A project can be deleted only if: - it is not public - it does not have public articles.\n\nWhen an individual project is deleted, all the articles are moved to my data of each owner.\n\nWhen a group project is deleted, all the articles and files are deleted as well. Only project owner, group admin and above can delete a project.\n"
        },
        {
          "info": {
            "name": "Private Project Publish",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/publish",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Publish a project. Possible after all items inside it are public"
        },
        {
          "info": {
            "name": "List project notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/notes",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. Used for pagination with page_size"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of results included on a page. Used for pagination with page"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results included on a page. Used for pagination with query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Where to start the listing (the offset of the first result). Used for pagination with limit"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "List project notes"
        },
        {
          "info": {
            "name": "Create project note",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/notes",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a new project note"
        },
        {
          "info": {
            "name": "Project note details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/notes/:note_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              },
              {
                "name": "note_id",
                "value": "",
                "type": "path",
                "description": "Note unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Project note details"
        },
        {
          "info": {
            "name": "Update project note",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/notes/:note_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              },
              {
                "name": "note_id",
                "value": "",
                "type": "path",
                "description": "Note unique identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Update project note"
        },
        {
          "info": {
            "name": "Delete project note",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/notes/:note_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              },
              {
                "name": "note_id",
                "value": "",
                "type": "path",
                "description": "Note unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Delete project note"
        },
        {
          "info": {
            "name": "Private Project Leave",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/leave",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Please note: project's owner cannot leave the project."
        },
        {
          "info": {
            "name": "List project collaborators",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/collaborators",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "List Project collaborators and invited users"
        },
        {
          "info": {
            "name": "Invite project collaborators",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/collaborators",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Invite users to collaborate on project or view the project"
        },
        {
          "info": {
            "name": "Remove project collaborator",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/collaborators/:user_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "User unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Remove project collaborator"
        },
        {
          "info": {
            "name": "List project articles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/articles",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "List project articles"
        },
        {
          "info": {
            "name": "Create project article",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/articles",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a new Article and associate it with this project"
        },
        {
          "info": {
            "name": "Project article details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/articles/:article_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              },
              {
                "name": "article_id",
                "value": "",
                "type": "path",
                "description": "Project Article unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Project article details"
        },
        {
          "info": {
            "name": "Delete project article",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/articles/:article_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              },
              {
                "name": "article_id",
                "value": "",
                "type": "path",
                "description": "Project Article unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Delete project article"
        },
        {
          "info": {
            "name": "Project article list files",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/articles/:article_id/files",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              },
              {
                "name": "article_id",
                "value": "",
                "type": "path",
                "description": "Project Article unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "List article files"
        },
        {
          "info": {
            "name": "Project article file details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.figshare.com/v2/account/projects/:project_id/articles/:article_id/files/:file_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "Project unique identifier"
              },
              {
                "name": "article_id",
                "value": "",
                "type": "path",
                "description": "Project Article unique identifier"
              },
              {
                "name": "file_id",
                "value": "",
                "type": "path",
                "description": "File unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://figshare.com/account/applications/authorize",
              "accessTokenUrl": "https://api.figshare.com/v2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Project article file details"
        }
      ]
    }
  ],
  "bundled": true
}