v1Recursos/Clients/getConsultar créditos do cliente
Consultar créditos do cliente
Lê os créditos exibidos em Clientes: recebidos, usados, disponíveis, último acréscimo e as últimas 50 entradas do histórico. Exige um usuário identificado da agência com acesso a Clientes e ao cliente solicitado. A permissão client-credits:read está disponível apenas nas permissões personalizadas das chaves API. A leitura não inicializa nem redefine o saldo. Quantidades internas de uso, custos de fornecedores, credenciais de pagamento e configurações de créditos não são retornados.
get
client-credits:read/api/v1/clients/{id}/creditsResposta
dataobjectobrigatório
clientIdstringobrigatório
givenintegerobrigatório
usedintegerobrigatório
remainingintegerobrigatório
lastAddedobjectobrigatório
creditsintegerobrigatório
atstringobrigatório
usedSinceintegerobrigatório
bystringobrigatório
historyarray of objectobrigatório
creditsintegerobrigatório
remainingAfterintegerobrigatório
notestringobrigatório
atstringobrigatório
bystringobrigatório
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
503O serviço está temporariamente indisponível. Tente adicionar os créditos novamente com a mesma chave de idempotência.
get/api/v1/clients/{id}/credits
Sua chave de API
{}Guias que usam este recurso
- Business Listings API: Complete Developer GuideHow a business listings API works and how to create, update, sync and monitor locations across Google, Apple, Bing and directories with the Synup API.
- Create a Location with the Synup APICreate a business location in one POST, with or without a client, get back a locationId, and know which fields matter and which can wait.
- How to Build a Reputation Management PlatformArchitecture and API calls for a multi-client reputation management platform on Synup: review ingestion, reply workflows, invites, widgets and reporting.
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- How to Build a White-Label Local Marketing PlatformBuild a multi-tenant white-label local marketing platform on the API, with client provisioning, team access, per-client summaries and scoped API keys.
- How to Build a Multi-Location Marketing DashboardBuild a multi-location marketing dashboard from the API's rollup endpoints, one call per panel, covering listings, reviews, rank, AI visibility and duplicates.
- How to Add Local Marketing Functionality to Vertical SaaSAdd local marketing to a vertical SaaS by mapping existing customers to clients and locations, and shipping only the features your niche needs.