Authentication

Authentication Every API request must carry your API key so {{productName}} knows it is you and which account to act on. You can send the key four different ways — all of them work on every endpoint that accepts API-key authentication, so pick whichever fits your setup. API access is a paid feature. If your plan does not include it, requests are rejected with a 403 even when the key itself is valid — see The paid-feature gate below. To generate a key, see API Access . HTTPS only. All requests must use a secure connection. Plain HTTP requests are rejected before authentication even runs. The four methods at a glance Method Carrier When to use Query parameter ?apiKey=YOUR_API_KEY Quick tests and browser URLs Header X-API-Key: YOUR_API_KEY Production integrations Bearer header Authorization: Bearer YOUR_API_KEY Production integrations Firebase ID token Authorization: Bearer <ID token> First-party app sessions only When more than one is present, the query parameter wins, then the X-API-Key header, then the bearer token. In practice you only ever send one. 1. Query parameter — `?apiKey=` Add your key to the end of the web address. This is the simplest form and always works, which makes it ideal for quick tests, scripts, and any older tooling. cURL curl "https://api.relaytiv.com/v1/contacts?apiKey=YOUR_API_KEY" JavaScript const res = await fetch("https://api.relaytiv.com/v1/contacts?apiKey=YOUR_API_KEY"); const data = await res.json(); Python import requests res = requests.ge