v1Resources/Clients/getGet client credits
Get client credits
Read the credits shown in Clients: given, used, remaining, last addition and the latest 50 history entries. Requires an identified agency user with Clients access and access to the requested client. The client-credits:read scope is available only through Custom API-key permissions. Reads do not initialize or reset the wallet. No internal usage quantities, provider costs, payment credentials or credit configuration are returned.
get
client-credits:read/api/v1/clients/{id}/creditsResponse
dataobjectrequired
clientIdstringrequired
givenintegerrequired
usedintegerrequired
remainingintegerrequired
lastAddedobjectrequired
creditsintegerrequired
atstringrequired
usedSinceintegerrequired
bystringrequired
historyarray of objectrequired
creditsintegerrequired
remainingAfterintegerrequired
notestringrequired
atstringrequired
bystringrequired
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The service is temporarily unavailable. Retry a credit grant with the same idempotency key.
get/api/v1/clients/{id}/credits
Your API key
{}Guides that use this resource
- 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.