Listar formulários
curl --request GET \
--url https://api.ararahq.com/v1/flows \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ararahq.com/v1/flows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.ararahq.com/v1/flows"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ararahq.com/v1/flows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": [
{
"id": "0b7e6a52-3c1d-4f7a-9a55-2f4f6f1f9c10",
"name": "Captar contato",
"category": "LEAD_GENERATION",
"status": "PUBLISHED",
"definition": {
"title": "Fale com a gente",
"intro": "Leva menos de um minuto.",
"submitLabel": "Enviar",
"fields": [
{
"key": "nome",
"label": "Seu nome",
"type": "TEXT",
"required": true,
"options": []
},
{
"key": "email",
"label": "Seu melhor e-mail",
"type": "EMAIL",
"required": true,
"options": []
},
{
"key": "interesse",
"label": "O que você procura?",
"type": "SELECT",
"required": true,
"options": [
{
"id": "falar_com_vendas",
"title": "Falar com vendas"
},
{
"id": "suporte",
"title": "Suporte"
}
]
}
]
},
"responseCount": 42,
"publishError": null,
"createdAt": "2026-09-15T14:30:00Z",
"publishedAt": "2026-09-15T14:30:04Z"
}
],
"pagination": {
"page": 0,
"size": 50,
"totalElements": 1,
"totalPages": 1
}
}Formulários
Listar formulários
Formulários da organização, do mais recente para o mais antigo, em
{ data, pagination }. O id de cada item é o flowId usado no envio.
Permissão: READ.
GET
/
v1
/
flows
Listar formulários
curl --request GET \
--url https://api.ararahq.com/v1/flows \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ararahq.com/v1/flows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.ararahq.com/v1/flows"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ararahq.com/v1/flows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": [
{
"id": "0b7e6a52-3c1d-4f7a-9a55-2f4f6f1f9c10",
"name": "Captar contato",
"category": "LEAD_GENERATION",
"status": "PUBLISHED",
"definition": {
"title": "Fale com a gente",
"intro": "Leva menos de um minuto.",
"submitLabel": "Enviar",
"fields": [
{
"key": "nome",
"label": "Seu nome",
"type": "TEXT",
"required": true,
"options": []
},
{
"key": "email",
"label": "Seu melhor e-mail",
"type": "EMAIL",
"required": true,
"options": []
},
{
"key": "interesse",
"label": "O que você procura?",
"type": "SELECT",
"required": true,
"options": [
{
"id": "falar_com_vendas",
"title": "Falar com vendas"
},
{
"id": "suporte",
"title": "Suporte"
}
]
}
]
},
"responseCount": 42,
"publishError": null,
"createdAt": "2026-09-15T14:30:00Z",
"publishedAt": "2026-09-15T14:30:04Z"
}
],
"pagination": {
"page": 0,
"size": 50,
"totalElements": 1,
"totalPages": 1
}
}Authorizations
Chave de API da Arara (ara_live_...), enviada no header Authorization: Bearer ara_live_.... Crie e gerencie as chaves no painel: https://app.ararahq.com/dashboard/apikeys. O valor completo aparece uma única vez, na criação.
Query Parameters
Página, começando em 0.
Required range:
x >= 0Itens por página.
Required range:
1 <= x <= 200