API Documentation

OAuth 2.0 credentials ​

Prerequisites ​

Who has access: Grammarly Enterprise and Grammarly for Education admins.

Not a customer yet? Contact sales.

Receive OAuth 2.0 credentials ​

Grammarly API uses OAuth 2.0 protocol for secure integration with third-party applications.

To receive OAuth credentials for your application, follow these steps:

  • Go to your Admin panel.
  • Open the Organization tab and choose OAuth 2.0 credentials in the Configurations section.
  • On the next page, click Add credential in the upper-right corner.
  • In the window that appears, enter a name and check the box next to the API you will use.
  • Click Create.
  • Next, click Copy to clipboard to save your Client ID and Secret.

Overview of OAuth scopes ​

Grammarly’s OAuth credentials can be assigned OAuth scopes, which are features that define the specific permissions granted to an OAuth client when accessing the Grammarly API. OAuth scopes limit access to only necessary resources, enhancing security by minimizing granted permissions.

Each OAuth client can be assigned the following scopes:

ScopeDescription
scores-api:readProvides read-only access to the Writing Score API, allowing applications to retrieve writing scores for submitted text. Suitable for applications that evaluate or analyze text quality, offering insights like writing clarity, engagement, and overall score.
scores-api:writeProvides write access to the Writing Score API, enabling applications to submit documents for writing score evaluations. Suitable for applications that evaluate or analyze text quality, offering insights like writing clarity, engagement, and overall score.
analytics-api:readGrants read-only access to the Analytics API, which provides Grammarly usage statistics for team plan members, including metrics like the number of writing sessions, the percentage of improved writing sessions, and generative AI prompt usage. This scope is commonly used by BI applications or analytical dashboards that show engagement with Grammarly.
users-api:readGrants read-only access to the License Management API, allowing applications to retrieve user and invitee details such as name, email, and subscription status, and get the institution subscription summary. Suitable for applications that need to retrieve user and invitee data for display purposes or account verification.
users-api:writeGrants write access to the License Management API, enabling applications to update and delete user and invitee information. Suitable for applications that need to remove users or invitees from the Grammarly subscription.