Saltearse al contenido

Listas

Las listas organizan contactos en grupos para campañas, exportaciones y segmentación.

Las listas también son el mecanismo mediante el cual los datos pasan del índice de datos abiertos a su espacio de trabajo. Al invocar /search/contacts/save o /search/companies/save, graph8 crea una nueva lista y la puebla con los registros coincidentes. Esos contactos y empresas pasan entonces a formar parte de sus datos propios, accesibles a través de los endpoints /contacts y /companies.


Listar todas las listas

GET /lists

Devuelve un listado paginado de todas las listas de su organización.

Parámetros de consulta

ParámetroTipoPredeterminadoDescripción
pageinteger1Número de página (indexado desde 1)
limitinteger50Elementos por página (1-200)

Ejemplo

Ventana de terminal
curl "https://be.graph8.com/api/v1/lists?limit=20" \
-H "Authorization: Bearer $API_KEY"

Respuesta

{
"data": [
{
"id": 10,
"title": "Enterprise Prospects Q1",
"type": "contacts",
"source": "graph8",
"status": "completed",
"total": 1250,
"is_dynamic": false,
"tags": ["enterprise", "q1-2026"],
"created_at": "2026-01-15T10:00:00Z",
"created_by": "user_abc123",
"updated_at": "2026-02-20T14:30:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 8,
"has_next": false
}
}

Crear lista

POST /lists

Crea una nueva lista vacía. Agregue contactos después mediante el endpoint Agregar contactos.

Cuerpo de la solicitud

CampoTipoRequeridoPredeterminadoDescripción
titlestringNombre de la lista
typestringNo"contacts"Tipo de lista: contacts, companies, suppressions, deals, leads

Ejemplo

Ventana de terminal
curl -X POST "https://be.graph8.com/api/v1/lists" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{"title": "Enterprise Prospects Q1", "type": "contacts"}'

Respuesta 201 Created

{
"data": {
"id": 11,
"title": "Enterprise Prospects Q1",
"type": "contacts",
"status": "completed",
"total": 0
}
}

Errores

EstadoSignificado
400Tipo de lista no válido

Eliminar lista

DELETE /lists/{list_id}

Eliminación lógica de una lista. La lista se marca como eliminada, pero no se borra de forma permanente.

Parámetros de ruta

ParámetroTipoDescripción
list_idintegerID de la lista

Ejemplo

Ventana de terminal
curl -X DELETE "https://be.graph8.com/api/v1/lists/10" \
-H "Authorization: Bearer $API_KEY"

Respuesta

{
"data": {
"deleted": true
}
}

Errores

EstadoSignificado
404Lista no encontrada

Obtener contactos de una lista

GET /lists/{list_id}/contacts

Devuelve los contactos de una lista específica.

Parámetros de ruta

ParámetroTipoDescripción
list_idintegerID de la lista

Parámetros de consulta

ParámetroTipoPredeterminadoDescripción
pageinteger1Número de página (indexado desde 1)
limitinteger50Elementos por página (1-200)

Ejemplo

Ventana de terminal
curl "https://be.graph8.com/api/v1/lists/10/contacts?limit=25" \
-H "Authorization: Bearer $API_KEY"

Respuesta

{
"data": [
{
"id": 1,
"first_name": "Jane",
"last_name": "Smith",
"full_name": "Jane Smith",
"work_email": "[email protected]",
"job_title": "VP of Engineering",
"seniority_level": "VP",
"direct_phone": "+1-555-0100",
"linkedin_url": "https://linkedin.com/in/janesmith",
"city": "San Francisco",
"state": "CA",
"country": "US"
}
],
"pagination": {
"page": 1,
"limit": 25,
"total": 1250,
"has_next": true
}
}

Agregar contactos a una lista

POST /lists/{list_id}/contacts

Agrega uno o más contactos a una lista mediante sus IDs.

Parámetros de ruta

ParámetroTipoDescripción
list_idintegerID de la lista

Cuerpo de la solicitud

CampoTipoRequeridoDescripción
contact_idsinteger[]IDs de los contactos a agregar

Ejemplo

Ventana de terminal
curl -X POST "https://be.graph8.com/api/v1/lists/10/contacts" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{"contact_ids": [1, 2, 3, 4, 5]}'

Respuesta 201 Created

{
"data": {
"added": 5
}
}

Eliminar contactos de una lista

DELETE /lists/{list_id}/contacts

Elimina uno o más contactos de una lista. Los contactos no se borran; únicamente se quitan de esta lista.

Parámetros de ruta

ParámetroTipoDescripción
list_idintegerID de la lista

Cuerpo de la solicitud

CampoTipoRequeridoDescripción
contact_idsinteger[]IDs de los contactos a eliminar

Ejemplo

Ventana de terminal
curl -X DELETE "https://be.graph8.com/api/v1/lists/10/contacts" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{"contact_ids": [3, 4]}'

Respuesta

{
"data": {
"removed": 2
}
}