How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Harvard University Access API

The Access API from Harvard University — 23 operation(s) for access.

Harvard University Access API is one of 50 APIs that Harvard University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

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

This API exposes 29 operations across 23 paths, and defines 218 schemas. It is described by OpenAPI 3.2.0, at version 6.10.1.

Requests are made against the base URL https://dataverse.harvard.edu/api.

29 operations 23 paths 218 schemas 2 DELETE17 GET6 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
6.10.1
Base URL
https://dataverse.harvard.edu/api
Resource Areas
1

Paths & Operations 29

Across 23 paths, the API surfaces 29 operations — 2 DELETE, 17 GET, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Access 29
GET
/access/datafile/bundle/{fileId}
Access datafile bundle
Access_datafileBundle 4 params → 200
POST
/access/datafile/bundle/{fileId}
Access datafile bundle with guestbook response
Access_datafileBundleWithGuestbookResponse 4 params → 200
GET
/access/datafile/{fileId}
Access datafile
Access_datafile 3 params → 200
POST
/access/datafile/{fileId}
Access datafile with guestbook response
Access_datafileWithGuestbookResponse 2 params → 200
GET
/access/datafile/{fileId}/auxiliary
Access list datafile metadata aux
Access_listDatafileMetadataAux 1 param → 200
GET
/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}
Access download auxiliary file
Access_downloadAuxiliaryFile 3 params → 200
DELETE
/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}
Access delete auxiliary file with version
Access_deleteAuxiliaryFileWithVersion 3 params → 200
GET
/access/datafile/{fileId}/auxiliary/{origin}
Access list datafile metadata aux by origin
Access_listDatafileMetadataAuxByOrigin 2 params → 200
GET
/access/datafile/{fileId}/metadata
Access tabular datafile metadata
Access_tabularDatafileMetadata 4 params → 200
GET
/access/datafile/{fileId}/metadata/ddi
Access tabular datafile metadata DDI
Access_tabularDatafileMetadataDDI 4 params → 200
PUT
/access/datafile/{id}/grantAccess/{identifier}
Access grant file access
Access_grantFileAccess 2 params → 200
GET
/access/datafile/{id}/listRequests
Access list file access requests
Access_listFileAccessRequests 1 param → 200
PUT
/access/datafile/{id}/rejectAccess/{identifier}
Access reject file access
Access_rejectFileAccess 2 params → 200
PUT
/access/datafile/{id}/requestAccess
Access request file access
Access_requestFileAccess 1 param → 200
DELETE
/access/datafile/{id}/revokeAccess/{identifier}
Access revoke file access
Access_revokeFileAccess 2 params → 200
GET
/access/datafile/{id}/userFileAccessRequested
Access get user file access requested
Access_getUserFileAccessRequested 1 param → 200
GET
/access/datafile/{id}/userPermissions
Access get user permissions on file
Access_getUserPermissionsOnFile 1 param → 200
POST
/access/datafiles
Access post download datafiles
Access_postDownloadDatafiles 2 params body → 200
GET
/access/datafiles/{fileIds}
Access datafiles
Access_datafiles 3 params → 200
POST
/access/datafiles/{fileIds}
Access datafiles with guestbook response
Access_datafilesWithGuestbookResponse 2 params → 200
GET
/access/dataset/{id}
Access download all from latest
Access_downloadAllFromLatest 3 params → 200
POST
/access/dataset/{id}
Access download all from latest with guestbook response
Access_downloadAllFromLatestWithGuestbookResponse 2 params → 200
GET
/access/dataset/{id}/versions/{versionId}
Access download all from version
Access_downloadAllFromVersion 6 params → 200
POST
/access/dataset/{id}/versions/{versionId}
Access download all from version with guestbook response
Access_downloadAllFromVersionWithGuestbookResponse 4 params → 200
GET
/access/dataverseFeaturedItemImage/{itemId}
Access get dataverse feature item image
Access_getDataverseFeatureItemImage 1 param → 200
GET
/access/dsCardImage/{versionId}
Access ds card image
Access_dsCardImage 1 param → 200
GET
/access/dvCardImage/{dataverseId}
Access dv card image
Access_dvCardImage 1 param → 200
GET
/access/fileCardImage/{fileId}
Access file card image
Access_fileCardImage 1 param → 200
PUT
/access/{id}/allowAccessRequest
Access allow access request
Access_allowAccessRequest 1 param → 200

Schemas 218

The contract defines 218 schemas that model the data the API accepts and returns. The most detailed are Dataverse (109 properties), Dataset (104 properties), DataFile (96 properties), DatasetVersion (95 properties). Each schema is shown below with its type and property counts.

SearchService
object
3 properties
Guestbook
object
20 properties 1 required
RoleAssignee
object
3 properties
DatasetLock
object
6 properties
SettingsServiceBean
object
4 properties
DownloadInstance
object
10 properties
OptionalAccessService
object
5 properties
SettingsWrapper
object
67 properties
DataverseRequest
object
6 properties
AuthenticationProviderDisplayInfo
object
3 properties
VariableInterval
string
EjbDataverseEngine
object
49 properties
AuthenticatedUserLookup
object
4 properties
JsonLDNamespace
object
2 properties
SummaryStatisticType
string
DataverseRequestServiceBean
object
3 properties
Alignment
string
PermissionServiceBean
object
13 properties
DataverseContact
object
4 properties 1 required
DataverseMetadataBlockFacet
object
3 properties
UserNotificationServiceBean
object
3 properties
SolrField
object
5 properties
DataVariable
object
31 properties 1 required
MetadataBlock
object
18 properties
OIDCAuthProvider
object
28 properties
DataFileServiceBean
object
9 properties
IpGroupsServiceBean
object
3 properties
FileAccessRequest
object
12 properties
VariableType
string
DatasetLinkingDataverse
object
4 properties
DataFile
object
96 properties 1 required
VariableMetadataUtil
object
SavedSearch
object
6 properties
CacheFactoryBean
object
3 properties
SavedSearchServiceBean
object
8 properties
HarvestingClient
object
40 properties 1 required
DefaultValueSet
object
3 properties
VariableRangeType
string
DataCaptureModuleServiceBean
object
SavedSearchFilterQuery
object
3 properties
ControlledVocabularyValue
object
7 properties
FileDownloadServiceBean
object
16 properties
FailedPIDResolutionLoggingServiceBean
object
1 property
DataverseType
string
DvObject
object
36 properties
PidProvider
object
15 properties
CustomQuestionResponse
object
5 properties
FileMetadata
object
22 properties 1 required
DataverseFieldTypeInputLevelServiceBean
object
1 property
AuthenticationProvider
object
11 properties
DatasetAuthor
object
8 properties
DifferenceSummaryGroup
object
3 properties
datasetReplaceFileItem
object
8 properties
BuiltinUserServiceBean
object
3 properties
RequestState
string
DvObjectServiceBean
object
3 properties
Reason
string
SolrClientIndexService
object
3 properties
SummaryNote
object
5 properties
DataverseLinkingServiceBean
object
2 properties
VariableMetadata
object
13 properties
DatasetExternalCitations
object
3 properties 1 required
VariableRange
object
16 properties
OAuth2TokenData
object
8 properties
CustomQuestionValue
object
4 properties 1 required
TagType
string
FileDifferenceDetailItem
object
3 properties
DatasetFieldCompoundValue
object
11 properties
DatasetField
object
28 properties
CategoryMetadata
object
4 properties
SystemConfig
object
82 properties
GuestbookResponse
object
22 properties
IpAddress
object
1 property
DatasetVersionFilesServiceBean
object
1 property
ExternalTool
object
16 properties
DataverseLinkingDataverse
object
4 properties
DownloadInfo
object
14 properties
ExplicitGroupProvider
object
4 properties
SearchServiceFactory
object
6 properties
BannerMessage
object
6 properties
VariableServiceBean
object
1 property
GroupProvider
object
2 properties
DatasetVersion
object
95 properties
Breadcrumb
object
4 properties
DataAccessRequest
object
2 properties
VariableCategory
object
8 properties
SolrClientService
object
3 properties
AuxiliaryFile
object
11 properties
BannerMessageServiceBean
object
1 property
Dataset
object
104 properties
DataverseServiceBean
object
22 properties
UserServiceBean
object
4 properties
WorkflowStepSPI
object
DataverseFieldTypeInputLevel
object
6 properties
DataverseFacet
object
4 properties
GlobusServiceBean
object
17 properties
IngestRequest
object
6 properties
DataverseSession
object
14 properties
ChecksumType
string
WorkflowServiceBean
object
10 properties
DatasetFieldsValidator
object
1 property
CurationStatus
object
6 properties
ImageFormat
string
Template
object
16 properties 1 required
IpGroupProvider
object
3 properties
DatasetVersionUser
object
4 properties
Scope
string
User
object
6 properties
IndexBatchServiceBean
object
11 properties
GuestbookResponseServiceBean
object
3 properties
Cart
object
1 property
UserBannerMessage
object
4 properties
MetadataBlockServiceBean
object
1 property
CustomQuestion
object
11 properties 1 required
PasswordValidatorServiceBean
object
9 properties
IngestReport
object
8 properties
EjbDataverseEngineInner
object
1 property
FeaturedDataverseServiceBean
object
2 properties
AlternativePersistentIdentifier
object
8 properties
FileVersionDifference
object
6 properties
AbstractOAuth2AuthenticationProvider
object
21 properties
ActionLogServiceBean
object
1 property
DatasetFieldType
object
48 properties
RoleAssigneeDisplayInfo
object
3 properties
OAIRecordServiceBean
object
4 properties
FileDifferenceSummaryItem
object
6 properties
IndexServiceBean
object
24 properties
DataverseTheme
object
15 properties
DataTable
object
12 properties
CommandContext
object
1 property
Metric
object
8 properties
DataFileTag
object
6 properties
RoleAssignment
object
7 properties
DataverseRoleServiceBean
object
6 properties
PrivateUrlServiceBean
object
3 properties
LicenseServiceBean
object
3 properties
DifferenceSummaryItem
object
6 properties
DatasetType
object
6 properties
OrcidOAuth2AP
object
23 properties
StorageIODataFile
object
44 properties
Command
object
3 properties
StorageUseServiceBean
object
1 property
DataFileCategory
object
4 properties
datasetFileDifferenceItem
object
19 properties
AuthenticationServiceBean
object
25 properties
ControlledVocabAlternate
object
4 properties
BannerMessageText
object
4 properties
TemplateServiceBean
object
2 properties
DatasetServiceBean
object
15 properties
DataverseFeaturedItemServiceBean
object
4 properties
DatasetVersionDifference
object
20 properties
JsonLDTerm
object
4 properties
DataverseFeaturedDataverse
object
4 properties
DevOAuthAccountType
string
RunResultType
string
IndexAsync
object
1 property
NavigationWrapper
object
3 properties
PidProviderFactory
object
1 property
SummaryStatistic
object
14 properties
DatasetLinkingServiceBean
object
2 properties
WorkflowComment
object
7 properties
ExplicitGroupServiceBean
object
3 properties
MailServiceBean
object
13 properties
AuxiliaryFileServiceBean
object
3 properties
MailDomainGroupProvider
object
3 properties
DatasetFieldValue
object
8 properties
VarGroup
object
4 properties
License
object
14 properties
GuestbookServiceBean
object
1 property
GroupServiceBean
object
10 properties
UserNotification
object
14 properties
Dataverse
object
109 properties 4 required
DatasetTypeServiceBean
object
1 property
DatasetFieldDefaultValue
object
9 properties
Type2
string
Retention
object
5 properties
SearchPermissionsServiceBean
object
8 properties
PasswordResetServiceBean
object
6 properties
RoleAssigneeServiceBean
object
6 properties
AuthenticationProvidersRegistrationServiceBean
object
13 properties
StorageQuota
object
3 properties
FieldType
string
AuthenticatedUserDisplayInfo
object
8 properties 2 required
DatasetFieldServiceBean
object
6 properties
Permission
string
DataverseFeaturedItem
object
9 properties 1 required
DataverseFacetServiceBean
object
2 properties
AuthenticationProviderFactory
object
2 properties
DataverseRole
object
7 properties
FileDownloadHelper
object
10 properties
EmbargoServiceBean
object
2 properties
ClientHarvestRun
object
16 properties
BundleDownloadInstance
object
5 properties
DataverseHeaderFragment
object
15 properties
TermsOfUseAndAccess
object
21 properties
Type
string
SolrIndexServiceBean
object
10 properties
SolrType
string
DatasetMetrics
object
17 properties 1 required
ExternalToolType
object
3 properties
Type1
string
ShibGroupServiceBean
object
4 properties
AuthenticatedUser
object
40 properties 4 required
ConfirmEmailServiceBean
object
5 properties
IngestServiceBean
object
9 properties
MailDomainGroupServiceBean
object
6 properties
MakeDataCountLoggingServiceBean
object
2 properties
VersionState
string
PidProviderFactoryBean
object
8 properties
Embargo
object
5 properties
MailDomainGroup
object
15 properties 1 required
FileDifferenceSummaryGroup
object
2 properties
StorageUse
object
3 properties
DatasetRelPublication
object
10 properties
VariableRangeItem
object
3 properties
ShibGroupProvider
object
3 properties
DatasetVersionServiceBean
object
8 properties
DatasetDistributor
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harvard-access-api-openapi.yml Raw ↑

Other APIs Harvard University publishes across the network.

Harvard Dataverse OAI-PMH
Harvard Library LibraryCloud API (Open Metadata)
Harvard Art Museums API
Harvard University Shibboleth Identity Provider (InCommon)
Caselaw Access Project bulk data (Harvard Library Innovation Lab)
Perma.cc API (Harvard Library Innovation Lab)
Harvard API Portal (HUIT)
Harvard DASH institutional repository (4Science-managed DSpace)
HOLLIS library discovery (Ex Libris Primo VE tenancy)
Harvard Figshare tenancy
Canvas LMS tenancy (Instructure)
Zoom tenancy
Where this information came from

This is an independent, third-party profile of Harvard University Access API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.