Skip to main content
GET
/
api
/
v2
/
clients
/
{client_id}
Get Client Details
curl --request GET \
  --url https://api.voiceaiwrapper.app/api/v2/clients/{client_id} \
  --header 'Authorization: Bearer <token>'
{
  "client": {
    "id": "<string>",
    "name": "<string>",
    "primary_email": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "users": [
      {
        "id": "<string>",
        "email": "<string>"
      }
    ]
  },
  "subscription": {
    "id": "<string>",
    "stripe_id": "<string>",
    "status": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "product": {
      "id": "<string>",
      "name": "<string>",
      "pricing_model": "<string>"
    },
    "pricing_details": {
      "pricing_model": "<string>",
      "prices": [
        {
          "id": "<string>",
          "stripe_price_id": "<string>",
          "billing_type": "<string>",
          "usage_type": "<string>",
          "unit_amount": 123,
          "currency": "<string>",
          "interval": "<string>",
          "active": true
        }
      ],
      "currency": "<string>",
      "interval": "<string>",
      "subscription_price": 123,
      "subscription_price_formatted": "<string>",
      "usage_price_tiers": [
        {
          "up_to": 123,
          "flat_amount": 123,
          "unit_amount": 123,
          "flat_amount_decimal": "<string>",
          "unit_amount_decimal": "<string>"
        }
      ],
      "min_minutes_included": 123,
      "additional_minute_price": 123,
      "additional_minute_price_formatted": "<string>"
    },
    "trial": {
      "trial_type": "<string>",
      "trial_days": 123,
      "trial_minutes": 123,
      "trial_end": "<string>",
      "trial_start": 123,
      "trial_minutes_assigned": 123,
      "trial_minutes_used": 123
    },
    "billing_cycle": {
      "current_period_start": "<string>",
      "current_period_end": "<string>",
      "billing_cycle_anchor": 123,
      "created": 123
    }
  },
  "usage": {
    "source": "<string>",
    "minutes_used": 123,
    "billing_period_start": 123,
    "billing_period_end": 123,
    "meter_id": "<string>"
  },
  "campaigns": {
    "total_campaigns": 123,
    "total_leads": 123,
    "total_calls": 123,
    "campaigns": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "<string>",
        "status": "<string>",
        "web_widget_enabled": true,
        "leads_count": 123,
        "calls_count": 123,
        "success_metrics": {},
        "success_evaluation_frequency": [
          {
            "status": "<string>",
            "count": 123,
            "percentage": 123
          }
        ]
      }
    ]
  },
  "form_submissions": [
    {
      "id": "<string>",
      "form_id": "<string>",
      "form_title": "<string>",
      "submitted_at": "2023-11-07T05:31:56Z",
      "response_data": {},
      "is_test": true
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

client_id
string
required

Global ID (or raw ID) of the client. Required.

Example:

"Q2xpZW50OjEyMw=="

Response

Client details retrieved successfully. Returns client info, subscription, usage, campaigns, and form submissions.

client
object
subscription
object
usage
object
campaigns
object
form_submissions
object[]