> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cocoondata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference Guide

## About this Guide

This guide describes each one of Covata's API endpoints, grouped according to the Covata Platform Service that exposes them.

### Access Service

**Authentication and authorization**

* [\<access-service>/api/oauth/token](/3.0/api/access-service-api-oauth-token.md)
* [\<access-service>/api/v1/auth/token/revoke](/3.0/api/access-service-api-v1-auth-token-revoke.md)

**Discovery Service**

* [\<access-service>/api/v1](/3.0/api/access-service-api-v1-discovery.md)

**Secure Object handling**

* [\<access-service>/api/v1/keys](/3.0/api/access-service-api-v1-keys.md)
* [\<access-service>/api/v1/keys/\{keyId}](/3.0/api/access-service-api-v1-keys-keyid.md)
* [\<access-service>/api/v1/objects](/3.0/api/access-service-api-v1-objects.md)
* [\<access-service>/api/v1/objects/\{objectId}](/3.0/api/access-service-api-v1-objects-objectid.md)
* [\<access-service>/api/v1/objects/\{objectId}/enable](/3.0/api/access-service-api-v1-objects-objectid-enable.md)
* [\<access-service>/api/v1/objects/\{objectId}/keys](/3.0/api/access-service-api-v1-objects-objectid-keys.md)
* [\<access-service>/api/v1/objects/\{objectId}/keys/view](/3.0/api/access-service-api-v1-objects-objectid-keys-view.md)
* [\<access-service>/api/v1/objects/bulk](/3.0/api/access-service-api-v1-objects-bulk.md)
* [\<access-service>/api/v1/permissions/sets](/3.0/api/access-service-api-v1-permissions-sets.md)

**Collection handling**

* [\<access-service>/api/v1/collections](/3.0/api/access-service-api-v1-collections.md)
* [\<access-service>/api/v1/collections/\{collectionId}](/3.0/api/access-service-api-v1-collections-collectionid.md)
* [\<access-service>/api/v1/collections/\{collectionId}/collections](/3.0/api/access-service-api-v1-collections-collectionid-collections.md)

**Item handling (i.e. both Secure Objects and collections)**

* [\<access-service>/api/v1/collaborations/items/\{itemId}](/3.0/api/access-service-api-v1-collaborations-items-itemid.md)
* [\<access-service>/api/v1/items](/3.0/api/access-service-api-v1-items.md)
* [\<access-service>/api/v1/items/\{itemId}](/3.0/api/access-service-api-v1-items-itemid.md)
* [\<access-service>/api/v1/items/\{itemId}/ancestry](/3.0/api/access-service-api-v1-items-itemid-ancestry.md)
* [\<access-service>/api/v1/items/\{itemId}/history](/3.0/api/access-service-api-v1-items-itemid-history.md)
* [\<access-service>/api/v1/items/\{itemId}/unshare](/3.0/api/access-service-api-v1-items-itemid-unshare.md)
* [\<access-service>/api/v1/items/delta](/3.0/api/access-service-api-v1-items-delta.md)
* [\<access-service>/api/v1/items/status](/3.0/api/access-service-api-v1-items-status.md)

**Covata Administration dashboard handling**

* [\<access-service>/api/v1/dashboard/clients](/3.0/api/access-service-api-v1-dashboard-clients.md)
* [\<access-service>/api/v1/dashboard/groups](/3.0/api/access-service-api-v1-dashboard-groups.md)
* [\<access-service>/api/v1/dashboard/items](/3.0/api/access-service-api-v1-dashboard-items.md)
* [\<access-service>/api/v1/dashboard/items/activity](/3.0/api/access-service-api-v1-dashboard-items-activity.md)
* [\<access-service>/api/v1/dashboard/items/extensions](/3.0/api/access-service-api-v1-dashboard-items-extensions.md)
* [\<access-service>/api/v1/dashboard/items/shared](/3.0/api/access-service-api-v1-dashboard-items-shared.md)
* [\<access-service>/api/v1/dashboard/ldap](/3.0/api/access-service-api-v1-dashboard-ldap.md)
* [\<access-service>/api/v1/dashboard/plans](/3.0/api/access-service-api-v1-dashboard-plans.md)
* [\<access-service>/api/v1/dashboard/plans/usage](/3.0/api/access-service-api-v1-dashboard-plans-usage.md)
* [\<access-service>/api/v1/dashboard/users](/3.0/api/access-service-api-v1-dashboard-users.md)
* [\<access-service>/api/v1/dashboard/users/activity](/3.0/api/access-service-api-v1-dashboard-users-activity.md)
* [\<access-service>/api/v1/dashboard/users/roles](/3.0/api/access-service-api-v1-dashboard-users-roles.md)
* [\<access-service>/api/v1/dashboard/whitelist](/3.0/api/access-service-api-v1-dashboard-whitelist.md)

**User handling**

* [\<access-service>/api/v1/users](/3.0/api/access-service-api-v1-users.md)
* [\<access-service>/api/v1/users/\{userid}](/3.0/api/access-service-api-v1-users-userid.md)
* [\<access-service>/api/v1/users/\{userId}/enable](/3.0/api/access-service-api-v1-users-userid-enable.md)
* [\<access-service>/api/v1/users/\{userId}/expire](/3.0/api/access-service-api-v1-users-userid-expire.md)
* [\<access-service>/api/v1/users/\{userId}/items/count](/3.0/api/access-service-api-v1-users-userid-items-count.md)
* [\<access-service>/api/v1/users/\{userId}/unlock](/3.0/api/access-service-api-v1-users-userid-unlock.md)
* [\<access-service>/api/v1/users/bulk](/3.0/api/access-service-api-v1-users-bulk.md)
* [\<access-service>/api/v1/users/import](/3.0/api/access-service-api-v1-users-import.md)
* [\<access-service>/api/v1/users/me](/3.0/api/access-service-api-v1-users-me.md)
* [\<access-service>/api/v1/users/me/applications/approvals](/3.0/api/access-service-api-v1-users-me-applications-approvals.md)
* [\<access-service>/api/v1/users/me/applications/approvals/\{approvalId}](/3.0/api/access-service-api-v1-users-me-applications-approvals-approvalid.md)
* [\<access-service>/api/v1/users/me/contacts](/3.0/api/access-service-api-v1-users-me-contacts.md)
* [\<access-service>/api/v1/users/me/contacts/\{contactId}](/3.0/api/access-service-api-v1-users-me-contacts-contactid.md)
* [\<access-service>/api/v1/users/me/items/count](/3.0/api/access-service-api-v1-users-me-items-count.md)
* [\<access-service>/api/v1/users/me/notifications/email](/3.0/api/access-service-api-v1-users-me-notifications-email.md)

**User whitelist handling**

* [\<access-service>/api/v1/userwhitelist](/3.0/api/access-service-api-v1-userwhitelist.md)
* [\<access-service>/api/v1/userwhitelist/\{userwhitelistId}](/3.0/api/access-service-api-v1-userwhitelist-userwhitelistid.md)
* [\<access-service>/api/v1/userwhitelist/bulk](/3.0/api/access-service-api-v1-userwhitelist-bulk.md)
* [\<access-service>/api/v1/userwhitelist/check](/3.0/api/access-service-api-v1-userwhitelist-check.md)

**LDAP handling**

* [\<access-service>/api/v1/ldap](/3.0/api/access-service-api-v1-ldap.md)
* [\<access-service>/api/v1/ldap/\{ldapconnectionId}](/3.0/api/access-service-api-v1-ldap-ldapconnectionid.md)
* [\<access-service>/api/v1/ldap/\{ldapconnectionId}/enable](/3.0/api/access-service-api-v1-ldap-ldapconnectionid-enable.md)
* [\<access-service>/api/v1/ldap/verifyconnection](/3.0/api/access-service-api-v1-ldap-verifyconnection.md)

**Label handling**

* [\<access-service>/api/v1/labels](/3.0/api/access-service-api-v1-labels.md)
* [\<access-service>/api/v1/labels/\{labelId}](/3.0/api/access-service-api-v1-labels-labelid.md)
* [\<access-service>/api/v1/labels/\{labelId}/priority](/3.0/api/access-service-api-v1-labels-labelid-priority.md)

**Group handling**

* [\<access-service>/api/v1/groups](/3.0/api/access-service-api-v1-groups.md)
* [\<access-service>/api/v1/groups/\{groupId}](/3.0/api/access-service-api-v1-groups-groupid.md)
* [\<access-service>/api/v1/groups/\{groupId}/labels](/3.0/api/access-service-api-v1-groups-groupid-labels.md)
* [\<access-service>/api/v1/groups/\{groupId}/users](/3.0/api/access-service-api-v1-groups-groupid-users.md)

**Plan handling**

* [\<access-service>/api/v1/plans](/3.0/api/access-service-api-v1-plans.md)
* [\<access-service>/api/v1/plans/\{planId}](/3.0/api/access-service-api-v1-plans-planid.md)

**Client Application handling**

* [\<access-service>/api/v1/clientapps](/3.0/api/access-service-api-v1-clientapps.md)
* [\<access-service>/api/v1/clientapps/\{clientInfoId}](/3.0/api/access-service-api-v1-clientapps-clientinfoid.md)
* [\<access-service>/api/v1/clientapps/\{clientInfoId}/enable](/3.0/api/access-service-api-v1-clientapps-clientinfoid-enable.md)

**Audit/report handling**

* [\<access-service>/api/v1/audit](/3.0/api/access-service-api-v1-audit.md)
* [\<access-service>/api/v1/audit/exportReport](/3.0/api/access-service-api-v1-audit-exportreport.md)

**Configuration handling**

* [\<access-service>/api/v1/config](/3.0/api/access-service-api-v1-config.md)
* [\<access-service>/api/v1/config/server](/3.0/api/access-service-api-v1-config-server.md)
* [\<access-service>/api/v1/config/server/\{configId}](/3.0/api/access-service-api-v1-config-server-configid.md)

**Theme handling**

* [\<access-service>/api/v1/config/theme/adminHelpUrl](/3.0/api/access-service-api-v1-config-theme-adminhelpurl.md)
* [\<access-service>/api/v1/config/theme/applicationName](/3.0/api/access-service-api-v1-config-theme-applicationname.md)
* [\<access-service>/api/v1/config/theme/companyName](/3.0/api/access-service-api-v1-config-theme-companyname.md)
* [\<access-service>/api/v1/config/theme/copyright](/3.0/api/access-service-api-v1-config-theme-copyright.md)
* [\<access-service>/api/v1/config/theme/emailHeaderDividerColor](/3.0/api/access-service-api-v1-config-theme-emailheaderdividercolor.md)
* [\<access-service>/api/v1/config/theme/headerPrimaryColor](/3.0/api/access-service-api-v1-config-theme-headerprimarycolor.md)
* [\<access-service>/api/v1/config/theme/headerTextColor](/3.0/api/access-service-api-v1-config-theme-headertextcolor.md)
* [\<access-service>/api/v1/config/theme/img/\{imageLocationToOverride}](/3.0/api/access-service-api-v1-config-theme-img-imagelocationtooverride.md)
* [\<access-service>/api/v1/config/theme/legalUrl](/3.0/api/access-service-api-v1-config-theme-legalurl.md)
* [\<access-service>/api/v1/config/theme/supportLink](/3.0/api/access-service-api-v1-config-theme-supportlink.md)
* [\<access-service>/api/v1/config/theme/versionUrl](/3.0/api/access-service-api-v1-config-theme-versionurl.md)
* [\<access-service>/api/v1/config/theme/webappHelpUrl](/3.0/api/access-service-api-v1-config-theme-webapphelpurl.md)
* [\<access-service>/api/v1/config/theme/...](/3.0/api/access-service-api-v1-config-theme-reset.md)

**Internationalization (I18n)**

* [\<access-service>/api/v1/i18n/adminpreference](/3.0/api/access-service-api-v1-i18n-adminpreference.md)
* [\<access-service>/api/v1/i18n/bundles](/3.0/api/access-service-api-v1-i18n-bundles.md)
* [\<access-service>/api/v1/i18n/bundles/\{localeCode}](/3.0/api/access-service-api-v1-i18n-bundles-localecode.md)
* [\<access-service>/api/v1/i18n/\{localeCode}/delete](/3.0/api/access-service-api-v1-i18n-localecode-delete.md)
* [\<access-service>/api/v1/i18n/\{localeCode}/download](/3.0/api/access-service-api-v1-i18n-localecode-download.md)
* [\<access-service>/api/v1/i18n/\{localeCode}/reset](/3.0/api/access-service-api-v1-i18n-localecode-reset.md)
* [\<access-service>/api/v1/i18n/localedetails](/3.0/api/access-service-api-v1-i18n-localedetails.md)
* [\<access-service>/api/v1/i18n/reload](/3.0/api/access-service-api-v1-i18n-reload.md)

### Content Service

**Discovery Service**

* [\<content-service>/api/v1](/3.0/api/content-service-api-v1-discovery.md)

**Secure Object handling**

* [\<content-service>/api/v1/objects/\{objectId}/contents](/3.0/api/content-service-api-v1-objects-objectid-contents.md)
* [\<content-service>/api/v1/objects/\{objectId}/view](/3.0/api/content-service-api-v1-objects-objectid-view.md)

**Collection handling**

* [\<content-service>/api/v1/collections/\{collectionId}/contents](/3.0/api/content-service-api-v1-collections-collectionid-contents.md)

**Item handling (i.e. both Secure Objects and collections)**

* [\<content-service>/api/v1/items/transfer](/3.0/api/content-service-api-v1-items-transfer.md)

**User handling**

* [\<content-service>/api/v1/users](/3.0/api/content-service-api-v1-users.md)
* [\<content-service>/api/v1/users/\{userid}/contents](/3.0/api/content-service-api-v1-users-userid-contents.md)
* [\<content-service>/api/v1/users/me](/3.0/api/content-service-api-v1-users-me.md)

**Plan handling**

* [\<content-service>/api/v1/plans/usage](/3.0/api/content-service-api-v1-plans-usage.md)
* [\<content-service>/api/v1/plans/usage/\{userid}](/3.0/api/content-service-api-v1-plans-usage-userid.md)

For an overview on how to use these programming points throughout this client library, refer to the [Getting Started Guide](/3.0/api/getting-started-guide.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.