Getting Started

Getting Started with the IdentityX GraphQL API

About the API

Much like the BaseCMS API the IdentityX API can be accessed using GraphQL -- an abstract query language for retrieving data in a standard format, originally developed by the team at Facebook. GraphQL Playground can be used as a locally installed API client, or the GraphQL connection can be accessed programmatically in most languages with the use of a client. For more information about using GraphQL check out the docs.

You'll need access to one or more organizations within IdentityX to read data from the API. If you don't yet have access, please reach out to an organization administrator.

If you have trouble connecting, please reach out to [email protected] and we'd be happy to help you out!

Connecting to the API

The IdentityX GraphQL API can be accessed at the following URL: https://identity-x.parameter1.com/graphql. Once connected, you can see available query documentation and schema definitions within the GraphQL Playground application (if using it).

See the Authentication section for detailed information about the available authentication methods for this API.

Usage

For detailed query usage information, see the Querying Data section.

Only a few high-level actions are documented here. To see the details of all available queries, mutations, and inputs, use a GraphQL client with a schema browser, such as Insomnia or GraphQL playground.

The IdentityX Schema browser within the Insomnia application