Skip to main content
The Supergraph is a unified GraphQL API that provides access to all platform services including authentication, booking, delivery, proctoring, and reporting. It serves as the primary integration point for all internal and external systems.

​
Base URL

GraphQL Endpoint: https://api.talview.com/v1/graphql Apollo Studio Explorer: https://studio.apollographql.com/public/talview/variant/current/explorer

​
Authentication

All API requests require authentication using JWT tokens. For simple integration workflows, Talview authentication workflows support SAML/Oauth2 SSO integrations, external iDP integrations and service principal authentication with scoped tokens.

​
Obtaining Access Token

The most straightforward way is to obtain tokens via the auth_user_login mutation using Password credentials workflow. The access_tokens issued are short expiry, either the refresh token can be used to create new access_tokens or fresh access_tokens can requested again. Example Request: 
curl --request POST \
  --url https://api.talview.com/v1/graphql \
  --header 'content-type: application/json' \
  --data '{"query":"mutation { auth_user_login( input: { identifier: \"<YOUR_EMAIL>\", password: \"<YOUR_PASSWORD>\", domain: \"<YOUR_DOMAIN>\" } ) { access_token refresh_token user { id first_name last_name email } } }"}'
Example Response: 
{
  "data": {
    "auth_user_login": {
      "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI...",
      "refresh_token": "d9865001-c918-4903-8209-…",
      "user": {
        "id": 123,
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]"
      }
    }
  }
}

​
Using Access Token

Include the access token in the Authorization header for all subsequent requests: 
curl --request POST \
  --url https://api.talview.com/v1/graphql \
  --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
  --header 'content-type: application/json' \
  --data '{"query":"query { ... }"}'

​
Error Handling

The API follows standard GraphQL error conventions. Errors thrown in both RESTful APIs and GraphQL endpoint use HTTP statuses as framework for error codes.
Status CodeDescription
200Success - OK, request accepted successfully
400Bad Request - Invalid query or variables
401Unauthorized - missing or invalid token
403Forbidden - insufficient permissions
422UnprocessableEntity - validation errors
429Too many requests - rate limit exceeded
500Internal Server Error
502Server timed out

​
Schema Definition and Reference

To explore the full capabilities of the Talview Supergraph, developers should refer to the official schema documentation. These resources provide a comprehensive guide to all available queries, mutations, and subscriptions. We recommend developers consult these references when building integrations to ensure they are utilizing the most up-to-date and efficient data fetching methods.