v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB

projects

Create project

Create a new project. Institutions with item-type based metadata enabled wrap metadata in a fields object (title, description, funding_list). Institutions without item-type based metadata can use the legacy flat-payload form. funding_list entries accept either {"id": <int>} (reference an existing record) or {"title": "..."} (mint a new user-defined entry). Unrecognised field names inside fields (e.g. a typo) are rejected with 422.

post/account/projects

Request body

titlestring

The title for this project. Required, 3 - 1000 characters. Legacy requests send it at the top level; requests for institutions with item-type based metadata enabled send it inside the fields object, where it is validated. Not listed in top-level required because those payloads carry it within fields.

descriptionstring

Project description

fundingstring

Grant number or organization(s) that funded this project. Up to 2000 characters permitted.

group_idinteger

Only if project type is group.

custom_fieldsobject

List of key, values pairs to be associated with the project

fieldsobject

Institutions with item-type based metadata only: all metadata fields keyed by underlying field name (e.g. title, description, funding_list). When present, the fields object is the authoritative source for all metadata; top-level metadata keys are ignored.

Example request

{
  "title": "project title",
  "description": "project description",
  "custom_fields": {
    "defined_key": "value for it"
  },
  "custom_fields_list": [
    {
      "name": "key"
    }
  ],
  "fields": {
    "title": "My Project",
    "description": "Project description",
    "funding_list": [
      {
        "title": "Test Grant"
      }
    ]
  }
}

Response

Created

entity_idinteger required

Figshare ID of the entity

locationstring url required

Url for entity

Example response

{
  "entity_id": 33334444
}