Using the GraphQL API with Recruitment CRM

You can enter requests using the GraphQL API based on data in different areas, or schema, within Recruitment CRM. As GraphQL uses the schema in Recruitment CRM, it provides you with the essential building blocks for developing apps. By understanding the schema, you can run requests that meet the requirements of your app.

If you are already familiar with the schema, you can go to the steps for Connecting to a GraphQL Endpoint or refer to the example sections. You can also refer to the full schema and documentation in the GraphQL IDE tool. Alternatively, you can familiarise yourself with the schema by trying out the Recruitment CRM dashboard in Workspace, The dashboard is built on the same underlying schema as that of the API.

Notes:

  • Some parts of the schema may not be available from the GraphQL IDE tool as this depends on the permissions that have been set up for you. If you require permission to access other parts of the schema, contact the development or service desk teams for Recruitment CRM.
  • The schema maps to the relational database tables used in Recruitment CRM.

Applicants

Applicants are an essential part of Recruitment CRM as they are placed in jobs by consultants. An applicant may/may not have been previously placed in a job from the same recruitment company.

The Recruitment CRM lets you view/add/update/delete details on one or more applicants including:

  • work history
  • CV details
  • attributes of an applicant, e.g., their skills

Contacts

Contacts help a consultant get a job for an applicant. They can work for the organisation in which the applicant is to be placed. You can view/add/update/delete details on contacts including:

  • basic details of the contact, e.g., their name.
  • consultants that work with the contact.
  • details on CVs that have been passed to the contact.

Jobs

Applicants work in jobs within organisations. You can view/add/edit/delete details of jobs including:

  • basic details of the job, e.g., the salary.
  • attributes of the job which enable job matching.
  • the type of job, e.g., permanent or contract.

Companies

Companies hold the jobs that require applicants. You can view/add/edit/delete details of a company including:

  • basic information, e.g., the address.
  • details on contacts that work at a company.
  • information on roles within a company.
  • attributes of a company for matching with a candidate.

Placements

Details on placements include information to ensure that consultants can create invoices and receive payment from a placement as part of the Candidate to Cash recruitment process. These include:

  • details of the negotiated salary.
  • information on the start date.
  • the name of the contact involved in the placement.
  • the name of the consultant involved in the placement

Persons

Persons are those that use Recruitment CRM for their day-to-day tasks, e.g., creating invoices.

Search

Data on all the above parts of the schema are searchable.

GDPR

Users are subject to legislation around GDPR. The schema allows consent details around GDPR to be recorded for candidate and contact communication.

See Also

Recruitment CRM GraphQL API

GraphQL Concepts