Skip to main content

API

Who this is for

Developers building integrations or automation on top of Owlie.

Goal

Understand how to call the Owlie GraphQL API and where to find reference docs.

Prereqs

  • API key access

Success criteria

You can authenticate and run a GraphQL query against your tenant.

Endpoint

POST https://<your-tenant>.owlie.app/api/graphql

Authentication

All API requests use API keys. Set the header:

Authorization: Owlie [APIKEY]

Reference

  • GraphQL schema: /api/graphql-schema
  • Authentication & patterns: /api/authentication
  • Common queries: /api/common-queries

Example

Query the API with an API key to list identities:

POST https://<your-tenant>.owlie.app/api/graphql
Authorization: Owlie [APIKEY]

Troubleshooting

  • 401 Unauthorized: API key missing or invalid.
  • 403 Forbidden: API key lacks required permissions.

Next steps

  • /api/authentication
  • /api/common-queries
  • /reference/errors

Send a POST request with a JSON body containing your GraphQL query:

curl -X POST https://<your-tenant>.owlie.app/api/graphql \
-H "Content-Type: application/json" \
-b "owlie_session=<session_token>" \
-d '{"query": "{ identities { id name } }"}'

Schema reference

Browse the full schema in the GraphQL Schema section.