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"
const res = await fetch('https://api.topyappers.com/api/v1/agent/projects', {
headers: {
'x-ty-api-key': process.env.TY_API_KEY,
},
});
const payload = await res.json();
Response fields
Each item inresponse.data includes:
| Field | Description |
|---|---|
id | Agent project ID. Use as projectId in other Agent Outreach endpoints. |
name | Project name. |
website / website_id | Website connected to the campaign. |
campaign_id | CRM campaign ID when linked. |
status | Agent status, such as active, paused, or disabled. |
deal_config | Structured deal terms used by the agent. |
target_keywords, target_categories, target_countries | Targeting setup. |
subject_override, prompt_override, message_body_override | Custom outreach instructions and overrides. |
total_emails_sent, total_responses, total_credits_used | Project counters. |
date_created, date_updated, last_run_at | ISO 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"
}
]
}
}
