Organization API

Organizations represent the top-level entity in SuperSend. Each user belongs to an organization, and all teams, campaigns, and resources are associated with an organization. You can retrieve your organization's details including limits, usage, and configuration settings.

Get Organization

Get the current user's organization details. Returns comprehensive information about the organization including limits, usage, and configuration settings. Note: Billing-related fields are excluded from the response.

Query Parameters:

Required:

• None (authentication via Bearer token)

Optional:

• None

curl -X GET 'https://api.supersend.io/v1/org' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

# Response
{
  "success": true,
  "data": {
    "id": "org-uuid",
    "name": "Acme Corporation",
    "domain": "acme.com",
    "logo": "https://example.com/logo.png",
    "trial_ends": "2025-12-31T23:59:59Z",
    "activeSubscription": true,
    "current_plan": "professional",
    "onboarding_completed": true,
    "is_enterprise": false,
    "whitelabel": false,
    "whitelabel_domain": null,
    "whitelabel_status": null,
    "email_senders_limit": 10,
    "email_senders_used": 5,
    "linkedin_senders_limit": 5,
    "linkedin_senders_used": 2,
    "twitter_senders_limit": 3,
    "twitter_senders_used": 1,
    "email_limit": 50000,
    "email_limit_used": 12500,
    "contact_limit": 100000,
    "additional_emails": 0,
    "additional_contacts": 0,
    "additional_email_senders": 0,
    "additional_linkedin_senders": 0,
    "additional_twitter_senders": 0,
    "verification_credits": 1000,
    "mail_warm_reply_rate": 30,
    "mail_warm_id": "ABC123",
    "mail_warm_monitor_blacklist": true,
    "warm_tracking_domain": true,
    "read_emulation": true,
    "randomize_send_amount": true,
    "number_of_employees": 50,
    "purpose_of_outbound_email": "Sales outreach and customer engagement",
    "deleted": false,
    "deactivated": false,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2025-11-27T10:30:00Z",
    "Price": {
      "id": "price-uuid",
      "name": "Professional Plan",
      "price": 99.00
    }
  }
}

Response Fields

Basic Information:

• id - string (UUID) - Organization unique identifier
• name - string - Organization name
• domain - string - Organization domain (optional)
• logo - string - URL to organization logo (optional)

Subscription Status:

• activeSubscription - boolean - Whether the organization has an active subscription
• current_plan - string - Current subscription plan name
• trial_ends - string (ISO 8601) - Date when trial period ends (if applicable)

Note: Billing-related fields (such as stripeCustomer, subscription_id, billing_email, billing_interval, etc.) are excluded from the response for security and privacy reasons.

Limits and Usage:

• email_senders_limit - integer - Maximum number of email senders allowed
• email_senders_used - integer - Number of email senders currently in use
• linkedin_senders_limit - integer - Maximum number of LinkedIn senders allowed
• linkedin_senders_used - integer - Number of LinkedIn senders currently in use
• twitter_senders_limit - integer - Maximum number of Twitter senders allowed
• twitter_senders_used - integer - Number of Twitter senders currently in use
• email_limit - integer - Maximum number of emails that can be sent
• email_limit_used - integer - Number of emails sent
• contact_limit - integer - Maximum number of contacts allowed
• verification_credits - integer - Number of email verification credits available
• additional_emails - integer - Additional email quota purchased
• additional_contacts - integer - Additional contact quota purchased
• additional_email_senders - integer - Additional email sender slots purchased
• additional_linkedin_senders - integer - Additional LinkedIn sender slots purchased
• additional_twitter_senders - integer - Additional Twitter sender slots purchased

Configuration:

• mail_warm_reply_rate - integer - Target reply rate for mail warming (percentage)
• mail_warm_id - string - Unique identifier for mail warming
• mail_warm_monitor_blacklist - boolean - Whether to monitor blacklist status
• warm_tracking_domain - boolean - Whether to use tracking domain for warming
• read_emulation - boolean - Whether to emulate email reads
• randomize_send_amount - boolean - Whether to randomize send amounts

Organization Details:

• onboarding_completed - boolean - Whether onboarding has been completed
• is_enterprise - boolean - Whether this is an enterprise organization
• whitelabel - boolean - Whether whitelabel is enabled
• whitelabel_domain - string - Whitelabel domain (if applicable)
• whitelabel_status - string - Whitelabel status (if applicable)
• number_of_employees - integer - Number of employees in the organization
• purpose_of_outbound_email - string - Purpose of outbound email campaigns

Status:

• deleted - boolean - Whether the organization is deleted (soft delete)
• deactivated - boolean - Whether the organization is deactivated
• createdAt - string (ISO 8601) - Organization creation timestamp
• updatedAt - string (ISO 8601) - Last update timestamp

Associated Data:

• Price - object - Associated pricing plan information (if available)
  • id - string (UUID) - Price ID
  • name - string - Plan name
  • price - number - Plan price

Error Responses

401 Unauthorized:

{
  "success": false,
  "error": "UNAUTHENTICATED",
  "message": "Not authenticated or organization not found"
}

404 Not Found:

{
  "success": false,
  "error": "Organization not found",
  "message": "The organization associated with your account was not found"
}

500 Internal Server Error:

{
  "success": false,
  "error": "Error message",
  "message": "Failed to retrieve organization"
}