Zum Hauptinhalt springen

Supported GraphQL Operations

GraphQL API keys created in the Developer Portal and OAuth 2.0 access tokens can access the same supported subset of the GraphQL schema. The one exception is generateComponentToken, which is API-key only.

Not all operations are available

Not every query, mutation, or field is available with an API key or an OAuth token. Only the operations listed below are supported, and only the fields shown in their reference pages can be selected. If you need an operation that isn't listed here, contact support and we can add it.

Send either credential as a bearer token.

An API key from the Developer Portal:

Authorization: Bearer ak_<environment>_<key-id>.<secret>

An OAuth 2.0 access token (see OAuth 2.0 Client Integration):

Authorization: Bearer <access-token>

Queries​

QueryDescription
attachmentReturns an attachment
templateReturns a template
documentReturns a document
batchReturns a batch
groupReturns a group
userReturns a user, or the API-key user context when no ID is supplied
taskReturns task status and report data
recipientReturns a document recipient

Mutations​

MutationDescription
cancelDocumentCancels a document if it has not been signed
createTemplateCreates a template and returns upload details
createTemplateElementCreates a new element (field) in a template
createTemplateRoleCreates a new role in a template
deleteTemplateElementDeletes an element (field) from a template
deleteTemplateRoleDeletes a role from a template
generateComponentTokenMints a short-lived token for authenticated widgets. API key only
sendSends one document
sendBatchStarts a batch send
sendBatchDocumentAdds a document to a batch
startBatchStarts a prepared batch
swapRolesSwaps the position of two roles in a template
updateTemplateUpdates a template's properties
updateTemplateElementUpdates an element (field) in a template
updateTemplateRoleUpdates a role in a template

Query Example​

The examples use an API key. With OAuth, send your access token in the same Authorization header.

curl https://graphql.uk.legalesign.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ak_<environment>_<key-id>.<secret>" \
--data '{
"query": "query GetDocument($id: ID!) { document(id: $id) { id name status created recipients { id email status } } }",
"variables": { "id": "<document-id>" }
}'

Send Example​

curl https://graphql.uk.legalesign.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ak_<environment>_<key-id>.<secret>" \
--data '{
"query": "mutation SendDocument($input: DocumentSendSettingsInput!) { send(input: $input) }",
"variables": {
"input": {
"groupId": "<group-id>",
"templateId": "<template-id>",
"title": "API Key Test Document",
"recipients": [
{
"firstName": "Jane",
"lastName": "Smith",
"email": "jane@example.com",
"order": 0
}
]
}
}
}'

Choosing an Auth Mode​

ModeCoverageHeaderBest for
API KeySupported subset onlyAuthorization: Bearer <api-key>Server-side automation and common send/read flows
OAuth 2.0Supported subset only (not generateComponentToken)Authorization: Bearer <access-token>Apps you build for your organisation's users, where each person signs in as themselves

Use the auth badges on query and mutation reference pages to confirm whether a root operation supports API-key and OAuth authentication.

Export This Article

Save a copy of this page as PDF or plain text.