Skip to main content
GET
/
v1
/
campaigns
/
{id}
Buscar campanha por ID
curl --request GET \
  --url https://api.nuvia.ai/v1/campaigns/{id} \
  --header 'Authorization: Bearer <token>'
{
  "_id": {},
  "company": {},
  "name": "<string>",
  "channel_type": {},
  "trigger_config": {},
  "audience_config": {},
  "metrics": {},
  "description": "<string>",
  "behavior_config": {},
  "linkedin_config": {},
  "last_execution_at": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Token JWT de autenticação

Headers

x-company-id
string

Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.

Path Parameters

id
string
required

ID da campanha

Response

200 - application/json
_id
object
required
company
object
required
name
string
required
channel_type
object
required
trigger_type
enum<string>
required
Available options:
MANUAL,
SCHEDULED,
RECURRING,
EXTERNAL_TRIGGER
trigger_config
object
required
audience_config
object
required
status
enum<string>
required
Available options:
DRAFT,
ACTIVE,
PAUSED,
COMPLETED,
ARCHIVED
metrics
object
required
description
string
behavior_config
object
linkedin_config
object
last_execution_at
string<date-time>
createdAt
string<date-time>
updatedAt
string<date-time>