OpenAPI
Use the OpenAPI specification to explore Ferretly endpoints, generate a client, or import requests into your API development tools. It includes request and response schemas, API-key authentication, and screening status callbacks.
| Detail | Value |
|---|---|
| Format | OpenAPI 3.0.1, JSON |
| Base URL | https://api.ferretly.com |
| Authentication | X-Api-Key request header |
Build your integration
Section titled “Build your integration”- Download the specification and import it into a tool that supports OpenAPI 3.0.
- Configure your API key on your server. See Authentication.
- Follow the Quickstart to make your first request.
Use the API reference to browse endpoints and schemas. For screening workflows, callback handling, and retry guidance, see Screening lifecycle, Webhooks, and Best practices.
Postman collection
Section titled “Postman collection”Import the collection, set the apiKey variable locally, and configure your subject and preference-profile IDs. Requests target the live API. Review write operations and state-changing GETs before sending; the create-subject example defaults to debug mode with analyst assignment disabled.
The collection contains no credentials or automatic request scripts. You can also import the OpenAPI file into Postman or another compatible tool.