Resumen de la cuenta
GET/v1/account
Scope necesario: read o full. Una clave full incluye send y read.
usage, con el tope propio de la organización si lo hay), límites de envío, recuentos de recursos y la clave que hace la petición. Solo lectura; 60 consultas por minuto y clave (compartidas con /v1/stats).
Respuestas
200Campo Descripción organizationobject · obligatorioorganization.idstring · obligatorioorganization.namestring · obligatorioorganization.statusstring · obligatorioEstado de la organización. valores: pending_review | active | paused | closedorganization.createdAtstring · obligatorioplanobject | null · obligatorioplan.codestring · obligatorioej.: beta plan.namestring · obligatorioej.: Beta plan.includedEmailsnumber · obligatorioEmails incluidos en el periodo. subscriptionobject | null · obligatoriosubscription.statusstring · obligatorioej.: active subscription.periodStartstring · obligatoriosubscription.periodEndstring · obligatorioperiodobject · obligatorioperiod.startstring · obligatorioperiod.endstring · obligatorioperiod.basisstring · obligatorio valores: subscription | calendar_utcsubscription: periodo de la suscripción;calendar_utc: mes natural UTC (sin suscripción vigente).usageobject · obligatoriousage.sentnumber · obligatorioEmails liveenviados en el periodo.usage.includednumber | null · obligatoriousage.remainingnumber | null · obligatoriousage.reservednumber · obligatorioEmails admitidos que aún no se han enviado. usage.capnumber | null · obligatorioTope del periodo: el menor entre el del plan (con la política de excedente) y el tope mensual propio de la organización si existe. usage.overagePolicystring · obligatoriovalores: hard_cap | overage limitsobject · obligatoriolimits.perSecondnumber | null · obligatoriolimits.dailynumber | null · obligatoriolimits.monthlynumber | null · obligatorioTope mensual propio ( nullsi no hay).countsobject · obligatoriocounts.domainsnumber · obligatoriocounts.verifiedDomainsnumber · obligatoriocounts.contactsnumber · obligatoriocounts.listsnumber · obligatoriocounts.segmentsnumber · obligatoriocounts.campaignsnumber · obligatoriocounts.templatesnumber · obligatorioPlantillas con una versión publicada. counts.webhooksnumber · obligatorioWebhooks del entorno de la clave. apiKeyobject · obligatorioapiKey.idstring · obligatorioapiKey.namestring · obligatorioapiKey.prefixstring · obligatorioej.: vm_live_ab12cd34 apiKey.environmentstring · obligatoriovalores: test | live apiKey.scopesstring[] · obligatorioej.: ["read"] 429Límite de consultas superado.
Ejemplo
curl https://api.vemudo.com/v1/account -H "Authorization: Bearer $VEMUDO_API_KEY"