Custom fields API

Overview

Lets you get information about custom fields used for your organization. For now, custom field creation, update and deletion is possible only through user interface.

Get all custom fields

Endpoint returns all custom fields for your organization.

Endpoint

http://prophy.eismea.eu/api/external/custom-fields/all/

Method: GET

Example GET request

Save the key in an environment variable: run this command, paste the key and press Enter. The key isn't shown on the screen and doesn't get into your shell history.

read -s PROPHY_API_KEY && export PROPHY_API_KEY

Then run the request:

curl -X GET "http://prophy.eismea.eu/api/external/custom-fields/all/" \
-H "X-ApiKey: $PROPHY_API_KEY"

Response object

Field	Description
author_from_group array of objects	List of Custom fields for Author from Group Go to object
folder array of objects	List of Custom fields for Folder Go to object
proposal array of objects	List of Custom fields for Proposal Go to object

custom_field

Field	Description
api_id string	UUID of the custom field
data_kind string	Kind of the custom field, possible values are: `number, str, date, single_option, multi_option`
preset string conditional	Present when the options of the field are known upfront, possible values are: `country, gender`. A value of such a field can be written as an `option_id`, as the option itself, or as any alias of it: `Greece`, `GR`, `GRC`, `EL` and `Ellada` all mean the same option of a `country` field, and `F`, `W`, `woman` and `FEMALE` the same option of a `gender` one. The options and their aliases are filled in when the field is created, and an orgadmin renames, deletes and adds to them afterwards.
name string	Name of the custom field
description nullable string	Description of the custom field
options array of objects conditional	Contains a list of options if the custom field is one of `single_option, multi_option`, otherwise not present in the object. Go to object

custom_field.option

Field	Description
api_id string	UUID of the option
option string	Value of the option

A custom field of an organization, rather than of one kind of document, is listed under every kind it can be written on, with the same api_id and the same options. It holds one value per document, so an author and a proposal that have the same option can be matched on it.

Example GET response

{
  "author_from_group": [
    {
      "api_id": "06571c47-4f2f-7262-8000-4cb0b7d099f0",
      "data_kind": "number",
      "name": "Average Days to review an article",
      "description": "Average Days to review an article"
    },
    {
      "api_id": "065aa2d4-2448-73ec-8000-1a4a0c37f008",
      "data_kind": "single_option",
      "name": "Status",
      "description": null,
      "options": [
        {
          "api_id": "065aa2d4-246e-79bb-8000-8c9b70efe4dc",
          "option": "Green"
        },
        {
          "api_id": "065aa2d4-246e-7b80-8000-e8ac0d6b2dc7",
          "option": "Yellow"
        },
        {
          "api_id": "065aa2d4-246e-7c5b-8000-a416ad58b676",
          "option": "Red"
        }
      ]
    },
    {
      "api_id": "06571c48-9385-7ab3-8000-d77c308cb3e8",
      "data_kind": "date",
      "name": "Last contacted",
      "description": "Last contacted"
    },
    {
      "api_id": "06571c33-7416-7c61-8000-1ace086d8afe",
      "data_kind": "single_option",
      "preset": "country",
      "name": "NAT1",
      "description": "Main nationality",
      "options": [
        {
          "api_id": "065aa2d4-246e-79bb-8000-8c9b70efe4dd",
          "option": "Greece"
        }
      ]
    },
    {
      "api_id": "06580564-84ee-7b4e-8000-c7b5ac9e6977",
      "data_kind": "str",
      "name": "NAT2",
      "description": "Secondary nationality"
    },
    {
      "api_id": "06571c35-762c-7bd9-8000-182d4e0473cf",
      "data_kind": "str",
      "name": "Open keywords",
      "description": "Keywords provided by the expert"
    },
    {
      "api_id": "06571c36-d65f-7666-8000-9503351b6b25",
      "data_kind": "str",
      "name": "Specialist Fields",
      "description": "Specialist Fields provided by the expert"
    },
    {
      "api_id": "065aa2d5-9626-796a-8000-126817d64cd5",
      "data_kind": "multi_option",
      "name": "Arxiv categories",
      "description": null,
      "options": [
        {
          "api_id": "065aa2d5-963a-78e7-8000-621a4e9399b4",
          "option": "astro-ph"
        },
        {
          "api_id": "065aa2d5-963a-7d18-8000-56ceb1516000",
          "option": "cond-mat"
        },
        {
          "api_id": "065aa2d5-963b-7f50-8000-931d4cd341af",
          "option": "hep-ph"
        },
        {
          "api_id": "065aa2d5-963d-7512-8000-e1b173090864",
          "option": "quant-ph"
        }
      ]
    }
  ],
  "folder": [
    {
      "api_id": "065c3437-6479-7f77-8000-c0159856aa79",
      "data_kind": "str",
      "name": "Call",
      "description": null
    }
  ],
  "proposal": [
    {
      "api_id": "065c343d-47cd-74ed-8000-081ede6ac167",
      "data_kind": "str",
      "name": "Acronym",
      "description": null
    }
  ]
}

Prophy API

API reference

Webhooks

MCP