Skip to main content
GET
/
api
/
v1
/
public
/
referrals
/
campaigns
Listar campanhas de indicação
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/referrals/campaigns \
  --header 'X-API-Key: <x-api-key>'
[
  {
    "campaign_id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "referrals_total": 0,
    "reward_type": "<string>",
    "reward_value": 123,
    "status": "active"
  }
]

Documentation Index

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

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

​
Listar Campanhas de Indicação

Retorna as campanhas de indicação da empresa autenticada pela API Key. Use o query param status para filtrar campanhas ativas ou inativas.

Headers

​
X-API-Key
string
required

Chave de API

Query Parameters

​
status
string | null

Filtrar por status: "active" ou "inactive"

Response

Successful Response

​
campaign_id
string
required
​
name
string
required
​
created_at
string<date-time> | null
​
expires_at
string<date-time> | null
​
referrals_total
integer
default:0
​
reward_type
string | null
​
reward_value
number | null
​
status
string
default:active