api.botsubscription.com

GET/v1/endpoint

AuthenticationBearer

Token

Stays in this tab. Required for this endpoint — the value below is what gets sent.

Path parameters0

Query parameters0

Headers0

BodyJSON

Examples

curl --request GET \
  --url https://api.botsubscription.com/v1/endpoint \
  --header 'Authorization: Bearer sk_live_•••'

Get Target - Fetch Access Destination Details via API

Retrieve a configured Discord role or Telegram channel or group by its internal target ID.

plan_count includes universal plans and retained links from archived plans. It is not a count of active memberships or proof that a target is used by an active plan.

GET/v2/projects/{project_id}/targets/{target_id}

Authorization

Bearer API KeyRequired

API key scope: targets:read (required for restricted keys).

Path Parameters

project_idstringrequired

The unique identifier of the project.

target_idstringrequired

The internal target ID (UUID).

The optional metadata below applies to each target in data. Optional keys may be omitted; a nullable field may be present with null.

Response Metadata

parent_target_idstring | null

Optional parent target UUID; null when there is no parent.

participant_countinteger

Optional nonnegative participant count.

originstring

Optional target origin: manual or auto-discovered.

discovered_atstring | null

Optional discovery time as a UTC ISO 8601 timestamp, or null when no discovery time is recorded.

curl -X GET "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/targets/11111111-1111-1111-1111-111111111111" \
  -H "Authorization: Bearer YOUR_API_KEY"

const project_id = 'YOUR_PROJECT_ID';
const target_id = '11111111-1111-1111-1111-111111111111';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/targets/${target_id}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await response.json();

import requests
 
project_id = 'YOUR_PROJECT_ID'
target_id = '11111111-1111-1111-1111-111111111111'
response = requests.get(
    f'https://api.botsubscription.com/v2/projects/{project_id}/targets/{target_id}',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
data = response.json()

$project_id = 'YOUR_PROJECT_ID';
$target_id = '11111111-1111-1111-1111-111111111111';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/targets/{$target_id}");
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_API_KEY']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Successapplication/json

{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/targets/11111111-1111-1111-1111-111111111111",
  "code": 200,
  "total": 1,
  "data": [
    {
      "target_id": "11111111-1111-1111-1111-111111111111",
      "target_name": "Premium Members",
      "platform": "discord",
      "kind": "role",
      "external_id": "123456789012345678",
      "is_enabled": true,
      "plan_count": 3,
      "parent_target_id": "22222222-2222-2222-2222-222222222222",
      "participant_count": 150,
      "origin": "manual",
      "availability": "available",
      "reason": null,
      "discovered_at": null
    }
  ]
}

Target not found (empty result)application/json

{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/targets/11111111-1111-1111-1111-111111111111",
  "code": 200,
  "total": 0,
  "data": []
}

Invalid UUID formatapplication/json

{
  "ok": false,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/targets/invalid-id",
  "code": 422,
  "errors": [
    {
      "message": "target_id Invalid UUID",
      "error_code": "VALIDATION_ERROR"
    }
  ]
}

Invalid or expired API keyapplication/json

{
  "ok": false,
  "request_id": "44444444-4444-4444-8444-444444444444",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/targets/22222222-2222-4222-8222-222222222222",
  "code": 401,
  "error": {
    "message": "Invalid or expired authentication token.",
    "error_code": "UNAUTHORIZED"
  }
}

Last updated: November 4, 2026