Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.topyappers.com/llms.txt

Use this file to discover all available pages before exploring further.

​
GET /api/v1/agent/projects

Returns active agent outreach projects for the API key owner’s team. 
curl -X GET "https://api.topyappers.com/api/v1/agent/projects" \
  -H "x-ty-api-key: $TY_API_KEY"

​
Response fields

Each item in response.data includes:
FieldDescription
idAgent project ID. Use as projectId in other Agent Outreach endpoints.
nameProject name.
website / website_idWebsite connected to the campaign.
campaign_idCRM campaign ID when linked.
statusAgent status, such as active, paused, or disabled.
deal_configStructured deal terms used by the agent.
target_keywords, target_categories, target_countriesTargeting setup.
subject_override, prompt_override, message_body_overrideCustom outreach instructions and overrides.
total_emails_sent, total_responses, total_credits_usedProject counters.
date_created, date_updated, last_run_atISO timestamp fields.

​
Example response

{
  "message": "OK",
  "response": {
    "data": [
      {
        "id": "662f01a2c86c2af2a2b9f123",
        "name": "Spring creator outreach",
        "website": "example.com",
        "website_id": "website_123",
        "campaign_id": "campaign_123",
        "status": "active",
        "target_keywords": ["fitness app", "meal prep"],
        "target_countries": ["United States"],
        "total_emails_sent": 84,
        "total_responses": 13,
        "date_created": "2026-05-01T10:15:00"
      }
    ]
  }
}