Getting started with the Foreplay API

The Foreplay API allows you to access any Foreplay data to build on-top of our advertising database of over 100m ads or build custom agentic workflows in platforms like N8N, Gumloop or Zapier.

Written By Jack Kavanagh

Last updated 6 months ago

ℹ️ You are currently on the platform knowledge base.For full technical documentation go here πŸ‘‰ API Technical Docs πŸ”—

To chat with the the API technical docs πŸ‘‰ Foreplay API GPT πŸ”—

How to get your API key

The Foreplay API is available across all plan types (excluding legacy plans). If you are having trouble accessing your API key or have questions about credits, check out Credits & Pricing

⚠️ Treat your API key like a password, don’t share it publicly or paste it into forums.

To create your access key.

  1. Go to your API settings: https://app.foreplay.co/api-overview

  2. Click the copy icon

Logs & Troubleshooting

As you are working with our API you can access logs directly from the API dashboard.

Access Logs Here: https://app.foreplay.co/api-logs

You can filter your logs by:

  • IP Address

  • Country

  • Endpoint

  • Response Status