GET /v1/organization

Retrieve complete organization details including all configuration settings, current usage statistics, and plan information. This endpoint returns comprehensive information about your VotePipe account including Discord webhook configurations, notification preferences, message templates, admin alert settings, and current usage metrics. Use this endpoint to audit your organization settings, check plan limits and usage, verify configuration, or synchronize settings with external systems. The response includes both current settings and usage statistics, making it ideal for building administrative dashboards or monitoring tools.

Request

http

GET https://api.votepipe.com/v1/organization
Authorization: Bearer mr_live_your_api_key_here

Response (200 OK)

json

{
  "data": {
    "id": "1",
    "slug": "my-server",
    "name": "My Server",
    "plan": "pro",
    "status": "active",
    "settings": {
      "discord_webhook_url": "https://discord.com/api/webhooks/123456789/abcdefghijk",
      "discord_admin_webhook_url": null,
      "discord_notifications_enabled": true,
      "discord_message_type": "simple",
      "discord_message_template": "🎉 **{{voter_name}}** voted on **{{provider_name}}**!",
      "discord_embed_template": {
        "color": 65280,
        "title": "🎉 New Vote Received!",
        "description": "**{{voter_name}}** just voted on **{{provider_name}}**",
        "fields": [
          {"name": "Vote ID", "value": "{{vote_id}}", "inline": true}
        ],
        "footer": {"text": "VotePipe • Vote Notification"},
        "timestamp": "{{received_at}}"
      },
      "admin_daily_summary": true,
      "admin_weekly_summary": true,
      "admin_vote_spike_alerts": true,
      "admin_permanent_fail_alerts": true,
      "admin_usage_warnings": true,
      "server_callback_url": null
    },
    "usage": {
      "votes_this_month": 1234,
      "votes_limit": 25000,
      "providers_count": 5,
      "providers_limit": 25
    }
  },
  "meta": {
    "request_id": "req_abc123"
  }
}

Response Fields

Field	Type	Description
id	string	Organization ID
slug	string	URL-friendly identifier
name	string	Display name
plan	string	Current plan (starter, growth, pro, business)
status	string	Organization status (active, suspended)
usage	object	Current usage statistics

Example: cURL

bash

curl -X GET https://api.votepipe.com/v1/organization \
  -H "Authorization: Bearer mr_live_your_api_key_here"

Example: JavaScript

javascript

const response = await fetch('https://api.votepipe.com/v1/organization', {
  headers: {
    'Authorization': 'Bearer mr_live_your_api_key_here'
  }
});
const data = await response.json();