Entrar
Esta tradução ainda não está disponível — mostrando versão em en-US.

Lifecycle

GET https://{organization}.myguper.com/api/register/customer/lifecycle

Returns a paginated list of customer IDs filtered by lifecycle stage or by churn forecast. Reads directly from the scheduled lifecycle tags — 5 (Lead), 6 (Customer), 7 (Churn). See the Customer Lifecycle guide.

Use it to build audiences such as "already churned" or "customers who will churn within N days / by a given date" — ideal to feed campaigns, exports or integrations. For a single customer's stage plus its churn forecast (churnAt), use the lifecycle object in Get customer.

Provide either stage or one of churnWithinDays / churnUntil. The churn-forecast params imply the Customer stage (an active customer whose predicted churn date falls between now and the given ceiling) and take precedence over stage.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

Send your user token in the x-guper-authorization header.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Parâmetros de query

Name Type Description
stage string Active stage now: `lead`, `customer` or `churn`.
churnWithinDays integer Customers whose predicted churn date is within the next N days (implies `stage=customer`).
churnUntil string Customers whose predicted churn date is on or before this date (`YYYY-MM-DD`, implies `stage=customer`).
e integer Page size (entries per page). Default 50.
p integer Page number. Default 1.

Respostas

{
    "list": [44356, 44409, 44411, 44526, 44202],
    "total": 291721,
    "pagination": { "entries": 5, "totalPages": 58345, "currentPage": 1, "isInitial": true, "isEnd": false }
}
Copied to clipboard