1. Credits
Highperformr API
  • Introduction
  • Contacts
    • Unified Data API - async contact enrichment
      POST
    • Bulk fetch contacts by IDs
      POST
    • Get contacts by segment
      POST
    • Get contact by ID
      GET
    • Update contact
      PATCH
    • Delete contact
      DELETE
    • Upsert contact into a source
      POST
    • Bulk upsert contacts for source
      POST
    • Unique values of one field for a filtered contact set
      POST
  • Schema
    • Get contact schema
      GET
    • Get discovery search contact schema
      GET
    • Get discovery search company schema
      GET
    • Get verified discovery contact filter schema
      GET
    • Get verified discovery company filter schema
      GET
    • Get options for field
      GET
    • Verified discovery autocomplete suggestions
      GET
    • Get discovery search options for field
      GET
    • Verified discovery static option lists
      GET
  • Discovery search
    • Find contacts v2
      POST
    • Find companies v2
      POST
    • Find verified contacts
      POST
    • Find verified companies
      POST
  • Jobs
    • Get job status by id
      GET
  • Social publishing
    • Create draft post
    • List posts (drafts, scheduled, published)
    • Schedule or publish posts (bulk)
    • Schedule a LinkedIn comment on an external post
    • Configure cross-account auto-repost
    • Upload media file (multipart)
    • Assemble chunked uploads into one file
    • Import media from a public URL
  • Integrations (social)
    • List social integrations (filter)
  • Segments
    • Type-ahead search for segments
    • Create segment
    • Get segment by ID
    • Update segment
    • Delete segment
    • Clone segment
    • Filter segments
  • Sources
    • Bulk upsert sources
    • Bulk fetch sources
    • Bulk update sources
    • Create source
    • Pull contacts from source
    • Get source by ID
    • Update source
  • Credits
    • Get workspace credit balance
      GET
    • Get credit usage analytics
      GET
  • Templates
    • Filter templates
    • Create template
    • Get template by ID
    • Update template
    • Delete template
  • Outreach
    • List connected LinkedIn sending accounts
    • List LinkedIn outreach campaigns
    • List inbox messages (incremental replies)
Login
  1. Credits

Get workspace credit balance

GET
/credits/credits-summary
Returns the current credit balance for the workspace (creditBalance). Same number the in-app Credits page shows.
API-key auth: send x-api-key. Optional accountId (workspace id) if the key does not already bind one. Optional authUserId if you need a specific user context; workspace keys fall back to the workspace creator.

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or

Responses

🟢200
application/json
Current credit balance.
Bodyapplication/json

🟠401
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://app.highperformr.ai/api/credits/credits-summary' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Success
{
    "creditBalance": 12480
}
Modified at 2026-10-07 08:33:47
Previous
Update source
Next
Get credit usage analytics
Built with