institutions

Private Account Institution Groups

Returns the groups for which the account has administrative privileges (assigned and inherited).

get/account/institution/groups

Request

Base URL
https://api.figshare.com/v2
Auth
OAuth 2
Authorization codehttps://figshare.com/account/applications/authorize
Token URLhttps://api.figshare.com/v2/token
Scopesall
TypeScript
https://skmtc.dev/figshare/apis/figshare-api/docs/account/institution/groups/get.ts
A function with typed inputs. Its response is checked against the schema.

OK. An array of Groups

idinteger required

Group id

namestring required

Group name

resource_idstring required

Group resource id

parent_idinteger required

Parent group if any

association_criteriastring required

HR code associated with group, if code exists

upload_access'All Users' | 'Admin Only' | 'None' required

Who can upload to this group. Possible values are "All Users", "Admin Only", and "None"

[
  {
    "id": 1,
    "name": "Materials",
    "association_criteria": "IT",
    "upload_access": "All Users"
  }
]

Jul 31, 20269dfb419f4430 Revision changes
- info
  added the required property / to the response with the status
Mar 27, 20265806e3dd43b2 Revision changes
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status