Authors from group API

Overview

Lets you create and updates authors from group. To create authors group, see Authors groups API →

Get author from group

Get the details of an author from group.

Endpoint

https://www.prophy.ai/api/external/author-from-group/{group_id}/{client_id}/

Method: GET

Path parameters

Parameter	Description
group_id integer	The ID of the authors group. This can be obtained from the response when creating an authors group or from the Prophy user interface.
client_id string	The client-side ID identifier of the specific author from group. This was used when adding the author to the group.

Example GET request

curl -X GET "https://www.prophy.ai/api/external/author-from-group/{group_id}/{client_id}/" \
-H "X-ApiKey: <API Key>"

Response object

Field	Description
name string	Name of the author from group
emails nullable list of strings	Emails of the author from group
orcids nullable list of strings	ORCID ids of the author from group
articles nullable list of strings	Articles descriptions that was provided for the author from group
affiliations nullable list of strings	Affiliation that was provided for the author from group
<custom_field_api_id> any	A value of the correspoding custom field. Values will be formatted according to the field's `data_kind`: `number` — float `str` — string `date` — date string in ISO format (YYYY-MM-DD) `single_option` — the `api_id` of the selected option `multi_option` — array of `api_id` for the selected options
author nullable object	Linked author of the author from group. Contains `null` if the author from group has no linked author. Go to object

author

Field	Description
id integer	Linked author ID
prophy_url string	A link to the linked author profile in Prophy
name string	A name of the linked author
articles_count integer	Number of published articles by the linked author
h_index integer	H-index of the linked author
last_articles array of objects	Last three articles published by the linked author Go to object

author.last_articles

Field	Description
prophy_url string	A link to article in Prophy
title string	Article title
year integer	Article publication year

Example GET response

{
  "name": "John Smith",
  "emails": ["[email protected]", "[email protected]"],
  "orcids": ["0000-0000-0000-0001"],
  "affiliations": [
      "University of Copenhagen, Denmark",
      "Ecole Polytechnique Federale de Lausanne, Switzerland"
  ],
  "articles": [
      "Exploring the Quantum Critical Behavior of Strongly Correlated Electron Systems",
      "From Quantum Materials to Quantum Technologies"
  ],
  "06571c47-4f2f-7262-8000-4cb0b7d099f0": 10.5,
  "06571c33-7416-7c61-8000-1ace086d8afe": "UK",
  "06571c48-9385-7ab3-8000-d77c308cb3e8": "2024-02-01",
  "065aa2d4-2448-73ec-8000-1a4a0c37f008": "065aa2d4-246e-79bb-8000-8c9b70efe4dc",
  "065aa2d5-9626-796a-8000-126817d64cd5": ["065aa2d5-963a-78e7-8000-621a4e9399b4", "065aa2d5-963a-7d18-8000-56ceb1516000"],
  "author": {
    "id": 13096,
    "prophy_url": "https://www.prophy.ai/author/13096/John-Smith/",
    "name": "John Smith",
    "articles_count": 143,
    "h_index": 30,
    "last_articles": [
      {
        "prophy_url": "https://www.prophy.ai/article/7023-Superconductivity-in-two-dimensional-materials/",
        "title": "Superconductivity in two-dimensional materials",
        "year": 2023
      },
      {
        "prophy_url": "https://www.prophy.ai/article/7024-Manipulation-of-spin-textures-by-unconventional-spin-torques/",
        "title": "Manipulation of spin textures by unconventional spin torques",
        "year": 2023
      },
      {
        "prophy_url": "https://www.prophy.ai/article/7025-Probing-new-physics-with-displaced-vertices-muon-tracker-at/",
        "title": "Probing new physics with displaced vertices: muon tracker at CMS",
        "year": 2022
      }
    ]
  }
}

Create or full update author from group

Create an author from group if it does not exist or fully update an existing one. The full update completely replaces an existing author from group record with the new data provided. Any fields not included in your request will be set to null values in the database.

Endpoint

https://www.prophy.ai/api/external/author-from-group/{group_id}/{client_id}/

Method: POST

Content Type: application/json

Path parameters

Parameter	Description
group_id integer	The ID of the authors group. This can be obtained from the response when creating an authors group or from the Prophy user interface.
client_id string	The client-side ID identifier of the specific author from group. This was used when adding the author to the group.

Request params

Field	Description
name string required	The name for the author from group
emails nullable list of strings	List of author's emails
orcids nullable list of strings	List of author's ORCIDs
articles nullable list of strings	A list of an articles published by the author. Will be used in disambiguation process. This can be a list of DOIs or a list of titles.
<custom_field_api_id> any	Include custom field api key and value into request body to add it for the author from group. You can obtain these custom field `api_id` values by using the Get all custom fields API endpoint or in the custom field interface in the organization admin panel. Values should be formatted according to the field's `data_kind`: `number` — integer of float value `str` — string value `date` — date in ISO format (YYYY-MM-DD) `single_option` — the `api_id` of the selected option `multi_option` — array of `api_id` values for the selected options

Example POST request

curl -X POST "https://www.prophy.ai/api/external/author-from-group/{group_id}/{client_id}/" \
-H "X-ApiKey: <API Key>" \
-H "Content-Type: application/json" \
-d '{
    "name": "John Smith",
    "emails": ["[email protected]", "[email protected]"],
    "orcids": ["0000-0000-0000-0001"],
    "affiliations": [
        "University of Copenhagen, Denmark",
        "Ecole Polytechnique Federale de Lausanne, Switzerland"
    ],
    "articles": [
        "Exploring the Quantum Critical Behavior of Strongly Correlated Electron Systems",
        "From Quantum Materials to Quantum Technologies"
    ],
    "06571c47-4f2f-7262-8000-4cb0b7d099f0": 10.5,
    "06571c33-7416-7c61-8000-1ace086d8afe": "UK",
    "06571c48-9385-7ab3-8000-d77c308cb3e8": "2024-02-01",
    "065aa2d4-2448-73ec-8000-1a4a0c37f008": "065aa2d4-246e-79bb-8000-8c9b70efe4dc",
    "065aa2d5-9626-796a-8000-126817d64cd5": ["065aa2d5-963a-78e7-8000-621a4e9399b4", "065aa2d5-963a-7d18-8000-56ceb1516000"]
}'

Response object

Field	Description
ok boolean	Indicates whether the operation was successful. In case of failure, the API will return a non-200 status code.

Example POST response

{
  "ok": true
}

Partial update author from group

Updates author from group record with only provided fields.

Endpoint

https://www.prophy.ai/api/external/author-from-group/{group_id}/{client_id}/partial/

Method: POST

Content Type: application/json

Path parameters

Parameter	Description
group_id integer	The ID of the authors group. This can be obtained from the response when creating an authors group or from the Prophy user interface.
client_id string	The client-side ID identifier of the specific author from group. This was used when adding the author to the group.

Request params

Field	Description
name string	The name for the author from group
emails nullable list of strings	List of author's emails
orcids nullable list of strings	List of author's ORCIDs
articles nullable list of strings	A list of an articles published by the author. Will be used in disambiguation process. This can be a list of DOIs or a list of titles.
<custom_field_api_id> any	Include custom field api key and value into request body to add it for the author from group. You can obtain these custom field `api_id` values by using the Get all custom fields API endpoint or in the custom field interface in the organization admin panel. Values should be formatted according to the field's `data_kind`: `number` — integer of float value `str` — string value `date` — date in ISO format (YYYY-MM-DD) `single_option` — the `api_id` of the selected option `multi_option` — array of `api_id` values for the selected options

Example POST request

curl -X POST "https://www.prophy.ai/api/external/author-from-group/{group_id}/{client_id}/partial/" \
-H "X-ApiKey: <API Key>" \
-H "Content-Type: application/json" \
-d '{
    "name": "John Smith",
    "emails": ["[email protected]", "[email protected]"],
    "orcids": ["0000-0000-0000-0001"],
    "affiliations": [
        "University of Copenhagen, Denmark",
        "Ecole Polytechnique Federale de Lausanne, Switzerland"
    ],
    "articles": [
        "Exploring the Quantum Critical Behavior of Strongly Correlated Electron Systems",
        "From Quantum Materials to Quantum Technologies"
    ],
    "06571c47-4f2f-7262-8000-4cb0b7d099f0": 10.5,
    "06571c33-7416-7c61-8000-1ace086d8afe": "UK",
    "06571c48-9385-7ab3-8000-d77c308cb3e8": "2024-02-01",
    "065aa2d4-2448-73ec-8000-1a4a0c37f008": "065aa2d4-246e-79bb-8000-8c9b70efe4dc",
    "065aa2d5-9626-796a-8000-126817d64cd5": ["065aa2d5-963a-78e7-8000-621a4e9399b4", "065aa2d5-963a-7d18-8000-56ceb1516000"]
}'

Response object

Field	Description
ok boolean	Indicates whether the operation was successful. In case of failure, the API will return a non-200 status code.

Example POST response

{
  "ok": true
}

Delete author from group

Delete author from group in a specific group.

Endpoint

https://www.prophy.ai/api/external/author-from-group/{group_id}/{client_id}/

Method: DELETE

Path parameters

Parameter	Description
group_id integer	The ID of the authors group. This can be obtained from the response when creating an authors group or from the Prophy user interface.
client_id string	The client-side ID identifier of the specific author from group. This was used when adding the author to the group.

Example DELETE request

curl -X DELETE "https://www.prophy.ai/api/external/author-from-group/{group_id}/{client_id}/" \
-H "X-ApiKey: <API Key>"

Response object

Field	Description
ok boolean	Indicates whether the operation was successful. In case of failure, the API will return a non-200 status code.

Example DELETE response

{
  "ok": true
}

Prophy API

API reference

Webhooks

Authors from group API

Overview

Get author from group

Endpoint

Path parameters

Example GET request

Response object

author

author.last_articles

Example GET response

Create or full update author from group

Endpoint

Path parameters

Request params

Example POST request

Response object

Example POST response

Partial update author from group

Endpoint

Path parameters

Request params

Example POST request

Response object

Example POST response

Delete author from group

Endpoint

Path parameters

Example DELETE request

Response object

Example DELETE response