Get started with GraphQL
In addition to REST APIs, the Skedulo API provides direct access to its data objects using GraphQL. GraphQL is a query language that allows selective access to objects in the data graph. Skedulo Lens supports GraphQL queries for all standard objects as well as any custom objects and fields you have defined.
GraphQL is a simple query language that allows you to access data from a remote endpoint. You can specify the shape of the data you want to be returned in the result to avoid over or under fetching. This allows you to return an object and its related objects in the graph using a single query.
To help you get started, the Skedulo web application includes the GraphiQL web extension. GraphiQL allows you to perform queries and mutations on your team’s data using GraphQL without needing to use another application outside of Skedulo.
To learn more about this web extension and how to add it to the web app, see Install the GraphiQL web extension.
You must have an API access token to perform GraphQL queries and mutations. For information about how to obtain an access token, see Authentication requirements and API tokens.
GraphQL provides a schema specification to express the types of queries and mutations that are available.
The full GraphQL Schema Definition Language specification for your Skedulo tenant is available by querying the
/graphql/schema endpoint as follows:
curl -X GET https://api.skedulo.com/graphql/schema -H "Authorization: Bearer $API_TOKEN"
$API_TOKEN environment variable is the access token obtained above.
The schema returned will include the standard Skedulo objects as well as any custom objects or fields you have defined.
Queries and mutations can be made against this schema using the
The Skedulo GraphQL HTTP server handles POST methods using the
application/json content type and with a JSON-encoded body. Responses, including both data and errors, are also returned in JSON format. For more information about encoding your GraphQL query as JSON, see the GraphQL documentation.
Was this page helpful?