Saltar al contenido
Facturador

Listar suscriptores

GET /api/subscriptions/subscribers

Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).

Lista los clientes habilitados de la empresa con sus datos de suscriptor, del más reciente al más antiguo.

Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor). Los registros de suscripciones son de toda la empresa: un vendedor ve y gestiona los mismos que el administrador.

Formato de respuesta: listado con paginación por cursor {success, data[], pagination: {next_cursor, has_more}}.

Parámetros de la URL (query):

Campo Tipo Obligatorio Descripción / valores permitidos
search string No Coincidencia parcial en nombre o número de documento.
parent_id integer No Solo los hijos de ese suscriptor.
only_parents 0 / 1 No 1 = solo los que no tienen padre.
with_subscriptions 0 / 1 No 1 = solo clientes que tienen alguna suscripción.
limit / cursor integer / string No Paginación por cursor.

Paginación por cursor: envía limit (1 a 100, por defecto 15). La respuesta trae pagination.next_cursor; para la página siguiente repite la misma consulta agregando cursor=<next_cursor>. Cuando pagination.has_more es false no hay más páginas.

Campos de cada suscriptor:

Campo Tipo Descripción
id integer Id del suscriptor (es el id del cliente: el mismo customer_id de los comprobantes).
identity_document_type_id / number / name / trade_name string Identificación.
email / telephone / address / country_id / location_id string / array Contacto y dirección.
parent_id integer o null Suscriptor padre.
discord_user / slack_channel / discord_channel / gitlab_user string o null Datos extra.
subscriptions_count integer Suscripciones del cliente.

Errores:

  • 401 sin token o con un token inválido.

Parámetros

Parámetro Dónde Obligatorio Ejemplo Descripción
search query no Nombre o número de documento.
parent_id query no 1520 Hijos de este suscriptor.
only_parents query no 1 Solo suscriptores sin padre.
with_subscriptions query sí 1 Solo con suscripciones.
limit query no 15 Registros por página, de 1 a 100. Por defecto 15.
cursor query no Valor de pagination.next_cursor de la respuesta anterior para obtener la página siguiente.

Respuestas

200 — Listado

{
  "success": true,
  "data": [
    {
      "id": 1520,
      "identity_document_type_id": "1",
      "number": "45879632",
      "name": "MARÍA FERNANDA QUISPE ROJAS",
      "trade_name": null,
      "email": "maria.quispe@correo.pe",
      "telephone": "987654321",
      "address": "Av. Arequipa 1450, Lince",
      "country_id": "PE",
      "location_id": [
        "15",
        "1501",
        "150116"
      ],
      "parent_id": null,
      "discord_user": "mquispe",
      "slack_channel": null,
      "discord_channel": "#socios-gold",
      "gitlab_user": null,
      "subscriptions_count": 1
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_more": false
  }
}

Pruébalo

Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.