GraphQL

    Suggestions will appear below the field as you type

    GraphQL

      Suggestions will appear below the field as you type

      GraphQL

      GraphQL

      The SEEK API uses GraphQL  to expose a graph of positions , candidates  and other business objects.
      GraphQL allows you to query and join SEEK’s objects together in whatever way best suits your software. It also gives SEEK insight into how its API is being used and which fields our partners are interested in.
      For more background on GraphQL we recommend the GraphQL Foundation’s Introduction to GraphQL .

      Code samples

      We provide GraphQL code samples across the Developer Site to demonstrate the implementation of features that are described in the documentation:
      QueryVariablesResult
      query ($id: String!) {
        hiringOrganization(id: $id) {
          name
        }
      }
      There are a few aspects to each code sample:
      1. The first tab displays the query or mutation operation that is being described.
      2. The second tab displays the input variables that are supplied alongside the operation.
      3. The third tab displays the result of executing the operation with the supplied variables.
      4. The Copy button copies the contents of the current tab to your clipboard.
        This may be useful to incorporate the sample code into your software or an API testing tool.
      5. The GraphQL Explorer button takes you to a dashboard page where you can execute the operation.
        The dashboard includes a lightweight, in-browser editor where you can execute GraphQL operations in one click. It is similar in usage to API testing tools like Postman and Insomnia.
        Our code samples reference mock objects in our read-only Playground environment. This allows us to document operations that can be executed by all partners; by contrast, access to production objects is typically restricted to a single hirer or partner.

      Dashboard

      The Developer Dashboard is an administrative user interface that lets you observe and configure your SEEK API integration:
      It’s a key component of our integration process and can be used to:

      Schema

      The schema documentation website lets you inspect low-level details of our GraphQL operations & types:
      This documentation is automatically generated from our GraphQL schema. You can introspect  the schema yourself by pointing GraphQL client tooling at https://graphql.seek.com/graphql. See GraphQL in practice for more information about our GraphQL endpoint and client tooling.