Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Carnegie Mellon University institutions API

The institutions API from Carnegie Mellon University — 20 operation(s) for institutions.

Carnegie Mellon University institutions API is one of 12 APIs that Carnegie Mellon University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include institutions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 24 operations across 20 paths, and defines 33 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://api.figshare.com/v2.

24 operations 20 paths 33 schemas 1 DELETE16 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.delphi.cmu.edu/epidata/
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Carnegie Mellon University institutions API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.

Paths & Operations 24

Across 20 paths, the API surfaces 24 operations — 1 DELETE, 16 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

institutions 24
GET
/institutions/{institution_string_id}/articles/filter-by
Public Institution Articles
institution_articles 3 params → 200500
GET
/account/institution
Private Account Institutions
private_institution_details → 200400403500
GET
/account/institution/embargo_options
Private Account Institution embargo options
private_institution_embargo_options_details → 200400403500
GET
/account/institution/articles
Private Institution Articles
private_institution_articles 12 params → 200400403500
GET
/account/institution/custom_fields
Private account institution group custom fields
custom_fields_list 1 param → 200400403500
POST
/account/institution/custom_fields/{custom_field_id}/items/upload
Custom fields values files upload
custom_fields_upload 1 param body → 200400403409500
GET
/account/categories
Private Account Categories
private_categories_list → 200400403500
GET
/account/institution/groups
Private Account Institution Groups
private_institution_groups_list → 200400403500
GET
/account/institution/groups/{group_id}/embargo_options
Private Account Institution Group Embargo Options
private_group_embargo_options_details 1 param → 200400403500
GET
/account/institution/roles
Private Account Institution Roles
private_institution_roles_list → 200400403500
GET
/account/institution/accounts
Private Account Institution Accounts
private_institution_accounts_list 9 params → 200400403500
POST
/account/institution/accounts
Create new Institution Account
private_institution_accounts_create body → 201400403500
GET
/account/institution/accounts/{account_id}
Private Institution Account information
private_institution_account 1 param → 200400403404500
PUT
/account/institution/accounts/{account_id}
Update Institution Account
private_institution_accounts_update 1 param body → 205400403404500
GET
/account/institution/roles/{account_id}
List Institution Account Group Roles
private_institution_account_group_roles 1 param → 200400403404500
POST
/account/institution/roles/{account_id}
Add Institution Account Group Roles
private_institution_account_group_roles_create 1 param body → 201400403500
DELETE
/account/institution/roles/{account_id}/{group_id}/{role_id}
Delete Institution Account Group Role
private_institution_account_group_role_delete 3 params → 204400403404500
POST
/account/institution/accounts/search
Private Account Institution Accounts Search
private_institution_accounts_search body → 200400403500
GET
/account/institution/users/{account_id}
Private Account Institution User
private_account_institution_user 1 param → 200400403404500
GET
/account/institution/reviews
Institution Curation Reviews
account_institution_curations 5 params → 200400403404500
GET
/account/institution/review/{curation_id}
Institution Curation Review
account_institution_curation 1 param → 200400403404500
GET
/account/institution/review/{curation_id}/comments
Institution Curation Review Comments
get_account_institution_curation_comments 3 params → 200400403404500
POST
/account/institution/review/{curation_id}/comments
POST Institution Curation Review Comment
post_account_institution_curation_comments 1 param body → 200400403404500
POST
/institution/hrfeed/upload
Private Institution HRfeed Upload
institution_hrfeed_upload body → 200400403500

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are ProjectArticle (23 properties), Account (19 properties), Article (16 properties), Curation (12 properties). Each schema is shown below with its type and property counts.

CategoryList
object
2 properties 2 required
AccountGroupRolesCreate
object
InstitutionAccountsSearch
object
8 properties
Institution
object
2 properties 2 required
ErrorMessage
object
2 properties
ProjectArticle
object
23 properties 22 required
Role
object
4 properties 4 required
User
object
9 properties 9 required
AccountCreate
object
8 properties 2 required
ShortAccount
object
12 properties 12 required
TimelineUpdate
object
3 properties
CurationCommentCreate
object
1 property 1 required
Author
object
7 properties 7 required
CurationDetail
object
1 property 1 required
Group
object
5 properties 5 required
GroupEmbargoOptions
object
3 properties 3 required
Category
object
6 properties 6 required
ResponseMessage
object
1 property 1 required
Article
object
16 properties 16 required
License
object
3 properties 3 required
Curation
object
12 properties 12 required
AccountCreateResponse
object
1 property 1 required
CurationComment
object
6 properties 6 required
RelatedMaterial
object
7 properties
AccountUpdate
object
2 properties 2 required
AccountGroupRoles
object
ArticleComplete
object
7 properties 7 required
ShortCustomField
object
6 properties 3 required
PublicFile
object
8 properties 7 required
CustomArticleField
object
6 properties 6 required
Timeline
FundingInformation
object
6 properties 6 required
Account
object
19 properties 19 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

carnegie-mellon-university-institutions-api-openapi.yml Raw ↑

Other APIs Carnegie Mellon University publishes across the network.

Delphi Epidata API
CMU Web Login (Shibboleth SSO)
Carnegie Mellon University altmetric API
Carnegie Mellon University articles API
Carnegie Mellon University authors API
Carnegie Mellon University collections API
Carnegie Mellon University oauth API
Carnegie Mellon University other API
Carnegie Mellon University profiles API
Carnegie Mellon University projects API
Carnegie Mellon University symplectic API