CMS: How to access the Scope GraphQL API
The Reporting Admin role is required to access the Scope GraphQL API.
Scope AR chose GraphQL for our API v3 because it offers significantly more flexibility for our integrators. The ability to define precisely the data you want—and only the data you want—is a powerful advantage over the REST API v2 endpoints.
How to enable a user for API access
The reporting admin feature is not enabled by default. In order to grant this role to users in your organization (including your own user account), contact Scope support and request that this feature be enabled.
Capabilities of the reporting admin role
-
A user with reporting admin role can read all data pertaining to a Scope customer account via GraphQL.
-
The reporting admin role does not grant write privileges. Write privileges can only be granted by assigning a license to the user.
-
The license and role assigned to a user dictate which data and operations can be operated on via the Scope GraphQL API (i.e. “Access Control Rights”).
Setting the reporting admin role
The reporting admin role can be managed by clicking on the respective user record:
