Command Palette

Search for a command to run...

GraphQL API

Pylo's public API is GraphQL. The admin panel runs on the same API, so everything you can do in the UI, you can do here.

Endpoint

https://api.pyloapp.com/graphql

Authentication

All requests require authentication: a Bearer token from user login or an API token created in the admin panel. See Authentication.

Making requests

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 } } }"}'

Generated operations

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

Built-in entities follow the same patterns:

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