Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

agencyName
string

Filter by agency name. Agency admins are always pinned to their own agency.

active
enum<string>

Filter by whether the project accepts calls.

Available options:
true,
false
locationId
string

Match a project location ID.

campaignId
string

Only projects containing this campaign.

agentId
string

Only projects with a campaign using this agent. Combined with campaignId, both must match the same campaign.

Case-insensitive business name search.

hasCampaigns
enum<string>

Filter by the presence of non-deleted campaigns.

Available options:
true,
false

Response

Visible projects.

success
boolean
required
data
object[]
required