# Figshare API API

> Figshare API API on Apizie: 136 endpoints (Private Account information, Private Articles, Create new Article, Account Article Report, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/open-data:figshare/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:figshare`
- Category: Open Data
- Status: byok
- Source: https://figshare.com
- Page: https://www.apizie.tech/api/open-data/figshare
- OpenAPI: https://www.apizie.tech/api/open-data/figshare/openapi.json

Figshare apiv2. Using Swagger 2.0

## Endpoints

### Private Account information
`GET https://www.apizie.tech/v1/open-data:figshare/private-account` (byok)

### Private Articles
`GET https://www.apizie.tech/v1/open-data:figshare/private-articles-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. Used for pagination with page_size |
| page_size | integer | no | The number of results included on a page. Used for pagination with page |
| limit | integer | no | Number of results included on a page. Used for pagination with query |
| offset | integer | no | Where to start the listing(the offset of the first result). Used for pagination with limit |

### Create new Article
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Account Article Report
`GET https://www.apizie.tech/v1/open-data:figshare/account-article-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group_id | integer | no | A group ID to filter by |

### Initiate a new Report
`POST https://www.apizie.tech/v1/open-data:figshare/account-article-report-generate` (byok)

### Private Articles search
`POST https://www.apizie.tech/v1/open-data:figshare/private-articles-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Article details
`GET https://www.apizie.tech/v1/open-data:figshare/private-article-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |

### Update article
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| body | object | yes | JSON request body |

### Delete article
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |

### List article authors
`GET https://www.apizie.tech/v1/open-data:figshare/private-article-authors-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |

### Add article authors
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-authors-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| body | object | yes | JSON request body |

### Replace article authors
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-authors-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| body | object | yes | JSON request body |

### Delete article author
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-author-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| author_id | integer | yes | Article Author unique identifier |

### List article categories
`GET https://www.apizie.tech/v1/open-data:figshare/private-article-categories-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |

### Add article categories
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-categories-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| body | object | yes | JSON request body |

### Replace article categories
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-categories-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| body | object | yes | JSON request body |

### Delete article category
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-category-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| category_id | integer | yes | Category unique identifier |

### Article confidentiality details
`GET https://www.apizie.tech/v1/open-data:figshare/private-article-confidentiality-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |

### Update article confidentiality
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-confidentiality-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| body | object | yes | JSON request body |

### Delete article confidentiality
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-confidentiality-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |

### Article Embargo Details
`GET https://www.apizie.tech/v1/open-data:figshare/private-article-embargo-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |

### Update Article Embargo
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-embargo-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| body | object | yes | JSON request body |

### Delete Article Embargo
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-embargo-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |

### List article files
`GET https://www.apizie.tech/v1/open-data:figshare/private-article-files-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |

### Initiate Upload
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-upload-initiate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| body | object | yes | JSON request body |

### Single File
`GET https://www.apizie.tech/v1/open-data:figshare/private-article-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| file_id | integer | yes | File unique identifier |

### Complete Upload
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-upload-complete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| file_id | integer | yes | File unique identifier |

### File Delete
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-file-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| file_id | integer | yes | File unique identifier |

### List private links
`GET https://www.apizie.tech/v1/open-data:figshare/private-article-private-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |

### Create private link
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-private-link-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| body | object | no | JSON request body |

### Update private link
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-private-link-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| link_id | string | yes | Private link token |
| body | object | no | JSON request body |

### Disable private link
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-private-link-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| link_id | string | yes | Private link token |

### Private Article Publish
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-publish` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |

### Private Article Reserve DOI
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-reserve-doi` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |

### Private Article Reserve Handle
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-reserve-handle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |

### Private Article Resource
`POST https://www.apizie.tech/v1/open-data:figshare/private-article-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| body | object | yes | JSON request body |

### Update article version
`POST https://www.apizie.tech/v1/open-data:figshare/article-version-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| version_id | integer | yes | Article version identifier |
| body | object | yes | JSON request body |

### Update article version thumbnail
`POST https://www.apizie.tech/v1/open-data:figshare/article-version-update-thumb` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article unique identifier |
| version_id | integer | yes | Article version identifier |
| body | object | yes | JSON request body |

### Search Authors
`POST https://www.apizie.tech/v1/open-data:figshare/private-authors-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Author details
`GET https://www.apizie.tech/v1/open-data:figshare/private-author-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| author_id | integer | yes | Author unique identifier |

### Private Account Categories
`GET https://www.apizie.tech/v1/open-data:figshare/private-categories-list` (byok)

### Private Collections List
`GET https://www.apizie.tech/v1/open-data:figshare/private-collections-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. Used for pagination with page_size |
| page_size | integer | no | The number of results included on a page. Used for pagination with page |
| limit | integer | no | Number of results included on a page. Used for pagination with query |
| offset | integer | no | Where to start the listing(the offset of the first result). Used for pagination with limit |
| order | string | no | The field by which to order. Default varies by endpoint/resource. |
| order_direction | string | no |  |

### Create collection
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Private Collections Search
`POST https://www.apizie.tech/v1/open-data:figshare/private-collections-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Collection details
`GET https://www.apizie.tech/v1/open-data:figshare/private-collection-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection Unique identifier |

### Update collection
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection Unique identifier |
| body | object | yes | JSON request body |

### Delete collection
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection Unique identifier |

### List collection articles
`GET https://www.apizie.tech/v1/open-data:figshare/private-collection-articles-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| page | integer | no | Page number. Used for pagination with page_size |
| page_size | integer | no | The number of results included on a page. Used for pagination with page |
| limit | integer | no | Number of results included on a page. Used for pagination with query |
| offset | integer | no | Where to start the listing(the offset of the first result). Used for pagination with limit |

### Add collection articles
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-articles-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| body | object | yes | JSON request body |

### Replace collection articles
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-articles-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| body | object | yes | JSON request body |

### Delete collection article
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-article-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| article_id | integer | yes | Collection article unique identifier |

### List collection authors
`GET https://www.apizie.tech/v1/open-data:figshare/private-collection-authors-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |

### Add collection authors
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-authors-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| body | object | yes | JSON request body |

### Replace collection authors
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-authors-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| body | object | yes | JSON request body |

### Delete collection author
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-author-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| author_id | integer | yes | Collection Author unique identifier |

### List collection categories
`GET https://www.apizie.tech/v1/open-data:figshare/private-collection-categories-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |

### Add collection categories
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-categories-add` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| body | object | yes | JSON request body |

### Replace collection categories
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-categories-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| body | object | yes | JSON request body |

### Delete collection category
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-category-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| category_id | integer | yes | Collection category unique identifier |

### List collection private links
`GET https://www.apizie.tech/v1/open-data:figshare/private-collection-private-links-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |

### Create collection private link
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-private-link-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| body | object | no | JSON request body |

### Update collection private link
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-private-link-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| link_id | string | yes | Private link token |
| body | object | no | JSON request body |

### Disable private link
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-private-link-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| link_id | string | yes | Private link token |

### Private Collection Publish
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-publish` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection Unique identifier |

### Private Collection Reserve DOI
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-reserve-doi` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection Unique identifier |

### Private Collection Reserve Handle
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-reserve-handle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection Unique identifier |

### Private Collection Resource
`POST https://www.apizie.tech/v1/open-data:figshare/private-collection-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | integer | yes | Collection unique identifier |
| body | object | yes | JSON request body |

### Search Funding
`POST https://www.apizie.tech/v1/open-data:figshare/private-funding-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Private Account Institutions
`GET https://www.apizie.tech/v1/open-data:figshare/private-institution-details` (byok)

### Private Account Institution Accounts
`GET https://www.apizie.tech/v1/open-data:figshare/private-institution-accounts-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. Used for pagination with page_size |
| page_size | integer | no | The number of results included on a page. Used for pagination with page |
| limit | integer | no | Number of results included on a page. Used for pagination with query |
| offset | integer | no | Where to start the listing(the offset of the first result). Used for pagination with limit |
| is_active | integer | no | Filter by active status |
| institution_user_id | string | no | Filter by institution_user_id |
| email | string | no | Filter by email |
| id_lte | integer | no | Retrieve accounts with an ID lower or equal to the specified value |
| id_gte | integer | no | Retrieve accounts with an ID greater or equal to the specified value |

### Create new Institution Account
`POST https://www.apizie.tech/v1/open-data:figshare/private-institution-accounts-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Private Account Institution Accounts Search
`POST https://www.apizie.tech/v1/open-data:figshare/private-institution-accounts-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update Institution Account
`POST https://www.apizie.tech/v1/open-data:figshare/private-institution-accounts-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | integer | yes | Account identifier the user is associated to |
| body | object | yes | JSON request body |

### Private Institution Articles
`GET https://www.apizie.tech/v1/open-data:figshare/private-institution-articles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. Used for pagination with page_size |
| page_size | integer | no | The number of results included on a page. Used for pagination with page |
| limit | integer | no | Number of results included on a page. Used for pagination with query |
| offset | integer | no | Where to start the listing(the offset of the first result). Used for pagination with limit |
| order | string | no | The field by which to order. Default varies by endpoint/resource. |
| order_direction | string | no |  |
| published_since | string | no | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD |
| modified_since | string | no | Filter by article modified date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD |
| status | integer | no | only return collections with this status |
| resource_doi | string | no | only return collections with this resource_doi |
| item_type | integer | no | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal… |

### Private account institution group custom fields
`GET https://www.apizie.tech/v1/open-data:figshare/custom-fields-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group_id | integer | no | Group_id |

### Custom fields values files upload
`POST https://www.apizie.tech/v1/open-data:figshare/custom-fields-upload` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| custom_field_id | integer | yes | Custom field identifier |
| body | object | no | Form fields as a JSON object |

### Private Account Institution embargo options
`GET https://www.apizie.tech/v1/open-data:figshare/private-institution-embargo-options-details` (byok)

### Private Account Institution Groups
`GET https://www.apizie.tech/v1/open-data:figshare/private-institution-groups-list` (byok)

### Private Account Institution Group Embargo Options
`GET https://www.apizie.tech/v1/open-data:figshare/private-group-embargo-options-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group_id | integer | yes | Group identifier |

### Institution Curation Review
`GET https://www.apizie.tech/v1/open-data:figshare/account-institution-curation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| curation_id | integer | yes | ID of the curation |

### Institution Curation Review Comments
`GET https://www.apizie.tech/v1/open-data:figshare/account-institution-curation-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| curation_id | integer | yes | ID of the curation |
| limit | integer | no | Number of results included on a page. Used for pagination with query |
| offset | integer | no | Where to start the listing(the offset of the first result). Used for pagination with limit |

### POST Institution Curation Review Comment
`POST https://www.apizie.tech/v1/open-data:figshare/post-account-institution-review-curation-id-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| curation_id | integer | yes | ID of the curation |
| body | object | yes | JSON request body |

### Institution Curation Reviews
`GET https://www.apizie.tech/v1/open-data:figshare/account-institution-curations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group_id | integer | no | Filter by the group ID |
| article_id | integer | no | Retrieve the reviews for this article |
| status | string | no | Filter by the status of the review |
| limit | integer | no | Number of results included on a page. Used for pagination with query |
| offset | integer | no | Where to start the listing(the offset of the first result). Used for pagination with limit |

### Private Account Institution Roles
`GET https://www.apizie.tech/v1/open-data:figshare/private-institution-roles-list` (byok)

### List Institution Account Group Roles
`GET https://www.apizie.tech/v1/open-data:figshare/private-institution-account-group-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | integer | yes | Account identifier the user is associated to |

### Add Institution Account Group Roles
`POST https://www.apizie.tech/v1/open-data:figshare/private-institution-account-group-roles-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | integer | yes | Account identifier the user is associated to |
| body | object | yes | JSON request body |

### Delete Institution Account Group Role
`POST https://www.apizie.tech/v1/open-data:figshare/private-institution-account-group-role-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | integer | yes | Account identifier for which to remove the role |
| group_id | integer | yes | Group identifier for which to remove the role |
| role_id | integer | yes | Role identifier |

### Private Account Institution User
`GET https://www.apizie.tech/v1/open-data:figshare/private-account-institution-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | integer | yes | Account identifier the user is associated to |

### Private Account Licenses
`GET https://www.apizie.tech/v1/open-data:figshare/private-licenses-list` (byok)

### Private Projects
`GET https://www.apizie.tech/v1/open-data:figshare/private-projects-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. Used for pagination with page_size |
| page_size | integer | no | The number of results included on a page. Used for pagination with page |
| limit | integer | no | Number of results included on a page. Used for pagination with query |
| offset | integer | no | Where to start the listing(the offset of the first result). Used for pagination with limit |
| order | string | no | The field by which to order. |
| order_direction | string | no |  |
| storage | string | no | only return collections from this institution |
| roles | string | no | Any combination of owner, collaborator, viewer separated by comma. Examples: "owner" or "owner,collaborator". |

### Create project
`POST https://www.apizie.tech/v1/open-data:figshare/private-project-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Private Projects search
`POST https://www.apizie.tech/v1/open-data:figshare/private-projects-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### View project details
`GET https://www.apizie.tech/v1/open-data:figshare/private-project-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |

### Update project
`POST https://www.apizie.tech/v1/open-data:figshare/private-project-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| body | object | yes | JSON request body |

### Delete project
`POST https://www.apizie.tech/v1/open-data:figshare/private-project-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |

### List project articles
`GET https://www.apizie.tech/v1/open-data:figshare/private-project-articles-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| page | integer | no | Page number. Used for pagination with page_size |
| page_size | integer | no | The number of results included on a page. Used for pagination with page |
| limit | integer | no | Number of results included on a page. Used for pagination with query |
| offset | integer | no | Where to start the listing(the offset of the first result). Used for pagination with limit |

### Create project article
`POST https://www.apizie.tech/v1/open-data:figshare/private-project-articles-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| page | integer | no | Page number. Used for pagination with page_size |
| page_size | integer | no | The number of results included on a page. Used for pagination with page |
| limit | integer | no | Number of results included on a page. Used for pagination with query |
| offset | integer | no | Where to start the listing(the offset of the first result). Used for pagination with limit |
| body | object | yes | JSON request body |

### Project article details
`GET https://www.apizie.tech/v1/open-data:figshare/private-project-article-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| article_id | integer | yes | Project Article unique identifier |

### Delete project article
`POST https://www.apizie.tech/v1/open-data:figshare/private-project-article-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| article_id | integer | yes | Project Article unique identifier |

### Project article list files
`GET https://www.apizie.tech/v1/open-data:figshare/private-project-article-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| article_id | integer | yes | Project Article unique identifier |

### Project article file details
`GET https://www.apizie.tech/v1/open-data:figshare/private-project-article-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| article_id | integer | yes | Project Article unique identifier |
| file_id | integer | yes | File unique identifier |

### List project collaborators
`GET https://www.apizie.tech/v1/open-data:figshare/private-project-collaborators-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |

### Invite project collaborators
`POST https://www.apizie.tech/v1/open-data:figshare/private-project-collaborators-invite` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| body | object | yes | JSON request body |

### Remove project collaborator
`POST https://www.apizie.tech/v1/open-data:figshare/private-project-collaborator-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| user_id | integer | yes | User unique identifier |

### Private Project Leave
`POST https://www.apizie.tech/v1/open-data:figshare/private-project-leave` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |

### List project notes
`GET https://www.apizie.tech/v1/open-data:figshare/private-project-notes-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| page | integer | no | Page number. Used for pagination with page_size |
| page_size | integer | no | The number of results included on a page. Used for pagination with page |
| limit | integer | no | Number of results included on a page. Used for pagination with query |
| offset | integer | no | Where to start the listing(the offset of the first result). Used for pagination with limit |

### Create project note
`POST https://www.apizie.tech/v1/open-data:figshare/private-project-notes-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| body | object | yes | JSON request body |

### Project note details
`GET https://www.apizie.tech/v1/open-data:figshare/private-project-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| note_id | integer | yes | Note unique identifier |

### Update project note
`POST https://www.apizie.tech/v1/open-data:figshare/private-project-note-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| note_id | integer | yes | Note unique identifier |
| body | object | yes | JSON request body |

### Delete project note
`POST https://www.apizie.tech/v1/open-data:figshare/private-project-note-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |
| note_id | integer | yes | Note unique identifier |

### Private Project Publish
`POST https://www.apizie.tech/v1/open-data:figshare/private-project-publish` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | integer | yes | Project unique identifier |

### Public Articles
`GET https://www.apizie.tech/v1/open-data:figshare/articles-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Cursor | string | no | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset… |
| page | integer | no | Page number. Used for pagination with page_size |
| page_size | integer | no | The number of results included on a page. Used for pagination with page |
| limit | integer | no | Number of results included on a page. Used for pagination with query |
| offset | integer | no | Where to start the listing(the offset of the first result). Used for pagination with limit |
| order | string | no | The field by which to order. Default varies by endpoint/resource. |
| order_direction | string | no |  |
| institution | integer | no | only return articles from this institution |
| published_since | string | no | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD |
| modified_since | string | no | Filter by article modified date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD |
| group | integer | no | only return articles from this group |
| resource_doi | string | no | only return articles with this resource_doi |
| item_type | integer | no | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal… |
| doi | string | no | only return articles with this doi |
| handle | string | no | only return articles with this handle |

### Public Articles Search
`POST https://www.apizie.tech/v1/open-data:figshare/articles-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Cursor | string | no | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset… |
| body | object | no | JSON request body |

### View article details
`GET https://www.apizie.tech/v1/open-data:figshare/article-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article Unique identifier |

### List article files
`GET https://www.apizie.tech/v1/open-data:figshare/article-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article Unique identifier |

### Article file details
`GET https://www.apizie.tech/v1/open-data:figshare/article-file-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article Unique identifier |
| file_id | integer | yes | File Unique identifier |

### List article versions
`GET https://www.apizie.tech/v1/open-data:figshare/article-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article Unique identifier |

### Article details for version
`GET https://www.apizie.tech/v1/open-data:figshare/article-version-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article Unique identifier |
| v_number | integer | yes | Article Version Number |

### Public Article Confidentiality for article version
`GET https://www.apizie.tech/v1/open-data:figshare/article-version-confidentiality` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article Unique identifier |
| v_number | integer | yes | Version Number |

### Public Article Embargo for article version
`GET https://www.apizie.tech/v1/open-data:figshare/article-version-embargo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| article_id | integer | yes | Article Unique identifier |
| v_number | integer | yes | Version Number |

…and 16 more. See the OpenAPI spec.

## Example
```
curl "https://www.apizie.tech/v1/open-data:figshare/private-account" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Figshare API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/open-data:figshare/private-account with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Figshare API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Figshare API itself also needs your own key from figshare.com.

### Can AI agents use the Figshare API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:figshare.

### What is the status of the Figshare API API?
Needs your own provider key (bring your own key)