The Coldy API uses a Bearer API key to identify your organization. In a few minutes, you can create a key and retrieve your campaigns.

  1. Create an API key

    Open Settings → Integrations, select API Keys, and generate a key for the organization you want to access. Copy it immediately; Coldy displays the complete value only once.

  2. Store the key securely

    Put the key in a secrets manager or protected server-side environment variable. The examples use COLDY_API_KEY.

    COLDY_API_KEY=YOUR_API_KEY

  3. Retrieve your campaigns

    Send the key as an HTTP Bearer credential.

    curl --request GET \
  --url https://developer.coldy.ai/api/v1/campaigns \
  --header "Authorization: Bearer $COLDY_API_KEY" \
  --header "Accept: application/json"

  4. Use the response

    A successful request returns 200 OK and the campaigns available to the organization associated with your key. Response properties use snake_case.

Next steps

  • Read Authentication before storing keys in production.
  • Learn how to handle errors and retries.
  • Browse the generated endpoint pages in the Resources navigation.

Identifiers and access

Campaign IDs are UUIDs. Account, lead, sequence, thread, and email IDs may be numeric and sequential. IDs are references—not credentials—and never grant access by themselves. Treat IDs as strings in generic clients unless you need to perform arithmetic on them.