Recruitment CRM GraphQL API
This guide introduces you to the GraphQL implementation of the Recruitment CRM API. GraphQL is a language for APIs that lets developers build apps through querying and manipulating data from a Recruitment CRM database. The querying capabilities allow the exact required data to be specified, which is delivered to the requesting clients via the HTTP protocol.
Benefits of the GraphQL API
Because the API uses a single endpoint by design, apps can be created more cost-effectiively. This is seen in the following ways:
- Apps can be developed while consuming a relatively low amount of data compared to other APIs (notably REST).
- New products and product updates can be delivered in more rapid iterations.
- Apps can benefit from more detailed insights on the required back-end data.
About this Guide
This guide includes the following:
- Basic concepts on the GraphQL API.
- How to connect to a GraphQL endpoint in order to run requests for querying and manipulating data.
- Information on the functions or schema that are available via the API for building apps.
- Worked examples that show different ways to query and manipulate data.
Prerequisites
If you are intending to use the API, you should ensure the following:
- You have the correct permissions set up for parts of the Recruitment CRM schema that you require.
- You have access to the correct Recruitment CRM website location for running requests.
- You have an API and integrator key for connecting securely to a GraphQL API endpoint.
See Also
Connecting to a GraphQL Endpoint
Using the GraphQL API with Recruitment CRM