targetwise-ai Account API

Free authenticated account-status checks.

Operations 1

GET /api/v1/account/status Check workspace access, allowances and balance for free #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/targetwise-ai:targetwise-ai-account-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

targetwise-ai-account-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Targetwise Ai Account API
  version: v1
  description: 'Operations tagged Account across 2 of this provider''s published API definitions: openapi.json, targetwise-ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://targetwise.ai
  description: Current deployment
tags:
- name: Account
  description: Free authenticated account-status checks.
paths:
  /api/v1/account/status:
    get:
      operationId: targetwise_account_status
      summary: Check workspace access, allowances and balance for free
      description: Validates the connected workspace key and returns remaining free email/phone results, paid balance, usage budget and plan access. Free and read-only; does not retrieve contact or company data or trigger automatic top-up. Lookup readiness is advisory; concurrent calls can change it.
      tags:
      - Account
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Authenticated workspace snapshot. Available even when usage is exhausted; not a reservation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountStatus'
        '400':
          description: Invalid request or operation_pricing_unavailable. Adding credit does not enable an unpriced operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Troubleshooting identifier.
        '401':
          description: A valid TargetWise bearer key is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Troubleshooting identifier.
            WWW-Authenticate:
              schema:
                type: string
        '402':
          description: Free allowance or paid balance exhausted, or usage_budget_reached. A top-up does not increase the monthly usage budget.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Troubleshooting identifier.
        '403':
          description: The workspace is inactive or access is restricted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Troubleshooting identifier.
        '409':
          description: Workspace usage could not be reserved. Inspect retryable before a bounded retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Troubleshooting identifier.
        '413':
          description: The request body exceeds 64 KB.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Troubleshooting identifier.
        '415':
          description: 'Use Content-Type: application/json.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Troubleshooting identifier.
        '429':
          description: The workspace attempt/rate limit or provider limit has been reached.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Troubleshooting identifier.
            Retry-After:
              schema:
                type: string
              description: Seconds to wait before retrying; also inspect error.retryable.
        '500':
          description: Unexpected internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Troubleshooting identifier.
        '502':
          description: The data connection returned an unusable response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Troubleshooting identifier.
        '503':
          description: The service or data connection is unavailable or unconfigured.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Troubleshooting identifier.
        '504':
          description: The data connection timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Troubleshooting identifier.
      x-targetwise-pricing:
        charge_cents: 0
        consumes_free_allowance: false
        triggers_automatic_topup: false
    servers:
    - url: https://targetwise.ai
      description: Current deployment
components:
  schemas:
    ApiError:
      type: object
      additionalProperties: false
      required:
      - error
      - request_id
      properties:
        request_id:
          type: string
        error:
          type: object
          additionalProperties: false
          required:
          - code
          - message
          - retryable
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            details: {}
    AccountStatus:
      type: object
      additionalProperties: false
      required:
      - object
      - request_id
      - key_valid
      - plan
      - subscription_status
      - billing_period
      - free_allowance
      - paid_balance
      - evaluation_remaining_credits
      - usage_budget
      - data_access
      - lookup_readiness
      - operations
      - rates
      - billing_url
      - message
      properties:
        object:
          type: string
          const: account_status
        request_id:
          type: string
        key_valid:
          type: boolean
          const: true
        plan:
          type: string
        subscription_status:
          type: string
        billing_period:
          type: object
          additionalProperties: false
          required:
          - starts_at
          - ends_at
          properties:
            starts_at:
              type: string
              format: date-time
            ends_at:
              type: string
              format: date-time
        free_allowance:
          type: object
          additionalProperties: false
          required:
          - emails
          - business_phones
          properties:
            emails:
              type: object
              additionalProperties: false
              required:
              - limit
              - used
              - remaining
              properties:
                limit:
                  type: integer
                  minimum: 0
                used:
                  type: integer
                  minimum: 0
                remaining:
                  type: integer
                  minimum: 0
            business_phones:
              type: object
              additionalProperties: false
              required:
              - limit
              - used
              - remaining
              properties:
                limit:
                  type: integer
                  minimum: 0
                used:
                  type: integer
                  minimum: 0
                remaining:
                  type: integer
                  minimum: 0
        paid_balance:
          type: object
          additionalProperties: false
          required:
          - currency
          - unit
          - available_cents
          - included_remaining_cents
          - prepaid_remaining_cents
          - reserved_cents
          properties:
            currency:
              type: string
              const: USD
            unit:
              type: string
              const: usd_cents
            available_cents:
              type: integer
              minimum: 0
            included_remaining_cents:
              type: integer
              minimum: 0
            prepaid_remaining_cents:
              type: integer
              minimum: 0
            reserved_cents:
              type: integer
              minimum: 0
        evaluation_remaining_credits:
          type: integer
          minimum: 0
        usage_budget:
          type: object
          additionalProperties: false
          required:
          - monthly_cap_cents
          - used_cents
          - reserved_cents
          - remaining_cents
          - resets_at
          properties:
            monthly_cap_cents:
              anyOf:
              - type: integer
                minimum: 0
              - type: 'null'
            used_cents:
              type: integer
              minimum: 0
            reserved_cents:
              type: integer
              minimum: 0
            remaining_cents:
              anyOf:
              - type: integer
                minimum: 0
              - type: 'null'
            resets_at:
              type: string
              format: date-time
        data_access:
          type: object
          additionalProperties: false
          required:
          - active
          - reason
          properties:
            active:
              type: boolean
            reason:
              type: string
        lookup_readiness:
          type: object
          additionalProperties: false
          required:
          - work_email
          - business_phone
          - email_and_phone
          properties:
            work_email:
              type: object
              additionalProperties: false
              required:
              - can_call
              - reason
              - maximum_paid_charge_cents
              properties:
                can_call:
                  type: boolean
                reason:
                  type: string
                maximum_paid_charge_cents:
                  type: integer
                  minimum: 0
            business_phone:
              type: object
              additionalProperties: false
              required:
              - can_call
              - reason
              - maximum_paid_charge_cents
              properties:
                can_call:
                  type: boolean
                reason:
                  type: string
                maximum_paid_charge_cents:
                  type: integer
                  minimum: 0
            email_and_phone:
              type: object
              additionalProperties: false
              required:
              - can_call
              - reason
              - maximum_paid_charge_cents
              properties:
                can_call:
                  type: boolean
                reason:
                  type: string
                maximum_paid_charge_cents:
                  type: integer
                  minimum: 0
        operations:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
            - operation
            - available_on_plan
            - input_condition
            properties:
              operation:
                type: string
                enum:
                - company_prospecting
                - contact_prospecting
                - company_enrichment
                - contact_enrichment
                - work_email_lookup
                - phone_lookup
                - reverse_email_lookup
                - company_search
                - employee_prospecting
                - employee_details
                - company_autocomplete
              available_on_plan:
                type: boolean
              input_condition:
                anyOf:
                - type: object
                  additionalProperties: true
                - type: 'null'
        rates:
          anyOf:
          - type: object
            additionalProperties: false
            required:
            - currency
            - email_cents
            - business_phone_cents
            properties:
              currency:
                type: string
                const: USD
              email_cents:
                type: integer
                minimum: 0
              business_phone_cents:
                type: integer
                minimum: 0
          - type: 'null'
        billing_url:
          type: string
          format: uri
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: TargetWise API key
x-refined-from:
- openapi.json
- targetwise-ai-openapi.json
x-targetwise-billing:
  currency: USD
  unit: usd_cents
  shared_channels:
  - dashboard
  - rest
  - mcp
  free_allowance:
    returned_work_emails: 20
    returned_business_phones: 5
    unused_results_kept_after_purchase: true
  plans:
  - key: paygo
    monthly_included_cents: 0
    email_cents: 9
    business_phone_cents: 18
  paid_charge_policy: Only requested email/phone fields actually returned are charged. Remaining free results are used first.
  reservation_policy: Reserve the maximum requested-field charge before retrieval; release unused reservations. Missing requested fields cost zero.
  balance_order:
  - remaining_free_results
  - prepaid_balance
  subscription_required: false
  prepaid_balance_carries_forward: true
  existing_subscription_terms_preserved: true
  minimum_prepaid_topup_cents: 10000
  larger_deposit_changes_rates: false
  usage_budget_period: UTC calendar month
  topup_increases_usage_budget: false
  account_status: https://targetwise.ai/api/v1/account/status
  pricing_url: https://targetwise.ai/pricing