API for RPA system

Access and control RPA system-related functions through the GraphQL API using the Nintex endpoint.

Before you begin:

  • Learn the fundamentals of GraphQL, the query language used to request and manage data through the Nintex public API.

  • Understand how to create effective queries and mutations to make requests and interact with the API.

  • Learn how to get and authenticate an access token.

  • Discover and understand the available endpoints.

Schema overview

The GraphQL API schema is a blueprint outlining the structure and functionality of the public APIs. The schema provides a clear overview of available data types, queries, and mutations, offering a foundation for understanding how to interact with the APIs effectively.

In GraphQL, using square brackets [ ] indicates a list, and the exclamation mark ! means non-nullable.

[Status!]!: The outer ! ensures that the API always returns a list (even if it's empty), and that the returned list will not be null.

Status!: The inner ! ensures that each element within the list is a non-nullable Status object. This guarantees that there won't be null values within the list, and any attempt to include null values would result in a failed query.

Copy 
extend type Query {
  getRpaServerVersion: String
}

API requests

The following API request provides the ability to retrieve system information using the Nintex endpoint:

Copy

QUERY 

query {
    getRpaServerVersion
}
Copy

GRAPHQL VARIABLES 


                        
Copy

RESPONSE 

{
    "data": {
        "getRpaServerVersion": "22.9"
    }
}