Command Palette

Search for a command to run...

GraphQL API

Pylo's public API is built using GraphQL. It's the same API we use internally for the admin panel, giving you full access to all features.

Endpoint

All GraphQL requests are made to your Pylo instance's GraphQL endpoint:

https://api.pyloapp.com/graphql

Authentication

All requests require authentication — either a JWT via the login endpoint or an API token created in the admin panel. See Authentication for details.

Making Requests

Send a POST request with your GraphQL query in the body:

terminal
1 2 3 4 curl -X POST https://api.pyloapp.com/graphql \ -H "Content-Type: application/json" \ -H "pylo-api-key: YOUR_API_KEY" \ -d '{ "query": "query { health { data { up } } }"}'

Dynamic Entities

Pylo generates GraphQL operations for each entity you define:

OperationPatternExample
List query{entity}ListcustomerList
By-ID query{entity}ByIdcustomerById
Create mutationcreate{Entity}createCustomer
Update mutationupdate{Entity}updateCustomer
Delete mutationdelete{Entity}deleteCustomer

System Entities

Pylo includes built-in system entities that follow the same patterns:

EntityDescription
PyloUserUser accounts and authentication
PyloMediaFiles and media uploads
PyloApiKeyAPI tokens for programmatic access
PyloAppApplication configuration