Jump to Content

Home Guides Recipes API Reference

API Reference

Home Guides Recipes API Reference

Faros API

💻 Accessing the API
Preferences
Report dashboards
Report flows
Report schedules
Webhooks
Webhook Events
Query
- Executes a GraphQL querypost
- Endpoint for preflight requestsoptns
Data
Account management
User management
- Gets the user profile for the callerget
- Authorizes a user for requested scopespost
User Role management
API keys
Named queries
Geocoding
- Gets normalized address information and coordinates for a locationpost
GitHub App

Powered by

Faros API

💻 Accessing the API
Preferences
Report dashboards
Report flows
Report schedules
Webhooks
Webhook Events
Query
- Executes a GraphQL querypost
- Endpoint for preflight requestsoptns
Data
Account management
User management
- Gets the user profile for the callerget
- Authorizes a user for requested scopespost
User Role management
API keys
Named queries
Geocoding
- Gets normalized address information and coordinates for a locationpost
GitHub App

Powered by

Creates an extract state

post https://prod.api.faros.ai/reports/schedules/{scheduleId}/extract-state

Language

Credentials

Header

Log in to use your API keys

Click Try It! to start a request and see the response here!