Saltar al contenido principal
GET
/
api
/
v1
/
contacts
List contacts
curl --request GET \
  --url https://app.flowella.io/api/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "phone": "<string>",
      "isOptedOut": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "waId": "<string>",
      "name": "<string>",
      "email": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://knowledge.flowella.io/llms.txt

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

Devuelve un listado paginado de los contactos almacenados en tu organización de Flowella. Usa el cursor de la respuesta para obtener las páginas siguientes.

Autenticación

Todas las solicitudes requieren la cabecera Authorization: Bearer <api_key> con una clave que empieza por el prefijo flo_.

Parámetros de consulta

limit
integer
predeterminado:"25"
Número máximo de elementos por página (entre 1 y 100).
cursor
string
Cursor de paginación devuelto en nextCursor de la respuesta anterior.

Respuesta

items
array
requerido
Array de contactos con los campos id, phone, waId, name, email, isOptedOut, createdAt y updatedAt.
nextCursor
string
Cursor para la siguiente página. Si falta, se ha llegado al final.

Errores

CódigoSignificado
401Falta la clave de API o no es válida.
429Limitado por tasa.

Ejemplo

curl "https://app.flowella.io/api/v1/contacts?limit=50" \
  -H "Authorization: Bearer flo_xxxxxxxxxxxxxxxxxxxxxxxx"

Autorizaciones

Authorization
string
header
requerido

Organization API key (flo_…). Send as Authorization: Bearer <key>.

Parámetros de consulta

limit
integer
predeterminado:25
Rango requerido: 1 <= x <= 100
cursor
string

Respuesta

Paginated contacts

items
object[]
requerido
nextCursor
string