Getting Started

Welcome to the Lightfunnels GraphQL API documentation! This page will provide you with an overview of how to get started with using the Lightfunnels GraphQL API.

Prerequisites

Before you start using the Lightfunnels GraphQL API, you will need the following:

  • An active Lightfunnels account. You can sign up here.
  • An client ID and app secret, which can be obtained by contacting our team
  • Familiarity with GraphQL, including the GraphQL syntax and GraphQL HTTP requests

Making a Query

To make a GraphQL query using the Lightfunnels API, you will need to send an HTTP POST request to the API endpoint with the following parameters:

  • query: The GraphQL query, encoded as a string
  • variables (optional): A JSON object containing variables for the query

Authorization

You should also include your API access token in the Authorization header of the request as follows:

Authorization header

Authorization: Bearer <your access token>

Learn how to get your access token on the Access Token page

Apps

To have access to an app you have to have an App ID, which can be obtained by contacting our team, then you can access your app through https://app.lightfunnels.com/admin/apps/{{app_id}}

Endpoint

The GraphQL API endpoint for all your queries is:

GraphQL endpoint

https://api.lightfunnels.com/graphql

Query Example

Here is an example of a GraphQL query to get the title of a product with the id of 1:

Example query

query getProduct{
    product(id: 1){
        title
    }
}

Example response:

Example query

{
    "data": {
        "product": {
            "title": "Awesome Product Example"
        }
    }
}

Learn more about GraphQL queries and mutations here

See it live on Postman

Click the button below to open the Lightfunnels collection in Postman and see the API working live.

Make sure you update the variables in the collection settings to your own values.

Run in Postman