Platform API

Last updated: Oct 28, 2026

The Fluid Attacks API is a GraphQL service. You can get data from it with a standard query language. GraphQL has one endpoint (app.fluidattacks.com/api) for requests with queries (to get data) and mutations (to create, update, or delete data).

If you already know GraphQL, go to "Learn the basics of the Fluid Attacks API".

Recommendations for new GraphQL users

These are some recommendations for developers who do not know GraphQL:

1. Understand what GraphQL is: Learn the basics of GraphQL, its functions, and how to write queries for a GraphQL endpoint. Fluid Attacks recommends that you read the official GraphQL introduction.
2. Learn to make queries and mutations: Before you use the API, learn the concepts of queries and mutations. They are the primary operations of each GraphQL endpoint.
3. Explore the Fluid Attacks API with the help of this documentation: After you learn the basic GraphQL concepts (queries, mutations, fields, and arguments), explore the API at app.fluidattacks.com/api. Use the examples below and then the examples in "Learn the basics of the Fluid Attacks API".

Examples

Retrieving user role

This example gets your role in the Fluid Attacks platform. Before you start, log in to app.fluidattacks.com.

query {
  me {
    role
  }
}

Retrieving groups

This example adds to the previous query to get information about your groups. The API gives the groups of an organization as a paginated connection. Thus, you request them with groupsConnection (which must have a first argument). Then, you read the fields of each group from the node in each of the edges (in this example, their names).

query {
  me {
    organizations {
      groupsConnection(first: 10) {
        edges {
          node {
            name
          }
        }
      }
    }
  }
}