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 a single base URL, https://dataverse.harvard.edu.

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_datafileBundle 4 params → 200
POST
/access/datafile/bundle/{fileId}
Access_datafileBundleWithGuestbookResponse 4 params → 200
GET
/access/datafile/{fileId}
Access_datafile 3 params → 200
POST
/access/datafile/{fileId}
Access_datafileWithGuestbookResponse 2 params → 200
GET
/access/datafile/{fileId}/auxiliary
Access_listDatafileMetadataAux 1 param → 200
GET
/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}
Access_downloadAuxiliaryFile 3 params → 200
DELETE
/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}
Access_deleteAuxiliaryFileWithVersion 3 params → 200
GET
/access/datafile/{fileId}/auxiliary/{origin}
Access_listDatafileMetadataAuxByOrigin 2 params → 200
GET
/access/datafile/{fileId}/metadata
Access_tabularDatafileMetadata 4 params → 200
GET
/access/datafile/{fileId}/metadata/ddi
Access_tabularDatafileMetadataDDI 4 params → 200
PUT
/access/datafile/{id}/grantAccess/{identifier}
Access_grantFileAccess 2 params → 200
GET
/access/datafile/{id}/listRequests
Access_listFileAccessRequests 1 param → 200
PUT
/access/datafile/{id}/rejectAccess/{identifier}
Access_rejectFileAccess 2 params → 200
PUT
/access/datafile/{id}/requestAccess
Access_requestFileAccess 1 param → 200
DELETE
/access/datafile/{id}/revokeAccess/{identifier}
Access_revokeFileAccess 2 params → 200
GET
/access/datafile/{id}/userFileAccessRequested
Access_getUserFileAccessRequested 1 param → 200
GET
/access/datafile/{id}/userPermissions
Access_getUserPermissionsOnFile 1 param → 200
POST
/access/datafiles
Access_postDownloadDatafiles 2 params body → 200
GET
/access/datafiles/{fileIds}
Access_datafiles 3 params → 200
POST
/access/datafiles/{fileIds}
Access_datafilesWithGuestbookResponse 2 params → 200
GET
/access/dataset/{id}
Access_downloadAllFromLatest 3 params → 200
POST
/access/dataset/{id}
Access_downloadAllFromLatestWithGuestbookResponse 2 params → 200
GET
/access/dataset/{id}/versions/{versionId}
Access_downloadAllFromVersion 6 params → 200
POST
/access/dataset/{id}/versions/{versionId}
Access_downloadAllFromVersionWithGuestbookResponse 4 params → 200
GET
/access/dataverseFeaturedItemImage/{itemId}
Access_getDataverseFeatureItemImage 1 param → 200
GET
/access/dsCardImage/{versionId}
Access_dsCardImage 1 param → 200
GET
/access/dvCardImage/{dataverseId}
Access_dvCardImage 1 param → 200
GET
/access/fileCardImage/{fileId}
Access_fileCardImage 1 param → 200
PUT
/access/{id}/allowAccessRequest
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.

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

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.