Skip to main content

How to Get a List of Floors

In this tutorial, we'll walk you through the steps to get a list of floors using the Butlr API. To get started, you'll need an access token, which can be obtained by logging in.

Prerequisites​

Before proceeding with this tutorial, you'll need the following:

  • A Butlr account
  • An API access token

Step 1: Get an access token by logging in (more info)​

To get an access token, you'll need to log in to the Butlr API using your email and password. Here's the curl command to do so:

curl --location --request POST 'https://api.butlr.io/api/v2/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "your@email.com",
    "password": "your_password"
}'

Replace your@email.com and your_password with your email and password.

The response will contain your access token, which you'll need to include in subsequent requests.

Step 2 - Query the Butlr API for Floors​

Now that you have your access token, you can use it to send a GraphQL query to the Butlr API's /api/v3/graphql endpoint to get a list of floors. Here is an example GraphQL query:

{
    floors {
        data {
            client_id
            floor_id
            name
            area {
                unit
                value
            }
            capacity {
                max
                mid
            }
        }
    }
}

This query requests a list of all floors, along with information such as their client ID, building ID, floor ID, name, area, and capacity.

Here's the cURL command to send this GraphQL query to the Butlr API:

curl --location --request POST 'https://api.butlr.io/api/v3/graphql' \
--header 'Authorization: Bearer INSERT_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{"query":"{\n    floors {\n        data {\n            client_id\n            floor_id\n            name\n            area {\n                unit\n                value\n            }\n            capacity {\n                max\n                mid\n            }\n        }\n    }\n}","variables":{}}'

Replace INSERT_ACCESS_TOKEN with your actual access token.

The response to this request will include a list of all floors in your Butlr account, along with the requested information.

Conclusion

In this tutorial, we walked you through the steps to get a list of floors using the Butlr API. By following these steps, you should now be able to retrieve floor data and use it in your applications.