Skip to main content
GET
/
v1
/
organizations
PHP (SDK)
declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$responses = $sdk->organizations->list(
    page: 1,
    limit: 10

);


foreach ($responses as $response) {
    if ($response->statusCode === 200) {
        // handle response
    }
}
{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "avatar_url": "<string>",
      "allow_customer_updates": true,
      "email": "<string>",
      "website": "<string>",
      "socials": [
        {
          "url": "<string>"
        }
      ],
      "details_submitted_at": "2023-11-07T05:31:56Z",
      "default_presentment_currency": "<string>",
      "feature_settings": {
        "issue_funding_enabled": false,
        "seat_based_pricing_enabled": false,
        "wallets_enabled": false,
        "member_model_enabled": false,
        "checkout_localization_enabled": false,
        "account_review_v2_enabled": false,
        "overview_metrics": [
          "<string>"
        ],
        "reset_proration_behavior_enabled": false,
        "off_session_charges_enabled": false,
        "billing_enabled": false,
        "slack_benefit_enabled": false
      },
      "subscription_settings": {
        "allow_multiple_subscriptions": true,
        "benefit_revocation_grace_period": 123,
        "prevent_trial_abuse": true,
        "allow_customer_updates": true
      },
      "notification_settings": {
        "new_order": true,
        "new_subscription": true
      },
      "customer_email_settings": {
        "order_confirmation": true,
        "subscription_cancellation": true,
        "subscription_confirmation": true,
        "subscription_cycled": true,
        "subscription_cycled_after_trial": true,
        "subscription_past_due": true,
        "subscription_renewal_reminder": true,
        "subscription_revoked": true,
        "subscription_trial_conversion_reminder": true,
        "subscription_uncanceled": true,
        "subscription_updated": true
      },
      "customer_portal_settings": {
        "usage": {
          "show": true
        },
        "subscription": {
          "update_seats": true,
          "update_plan": true
        },
        "customer": {
          "allow_email_change": true
        }
      },
      "account_id": "<string>",
      "payout_account_id": "<string>",
      "capabilities": {
        "checkout_payments": true,
        "subscription_renewals": true,
        "payouts": true,
        "refunds": true,
        "api_access": true,
        "dashboard_access": true
      }
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

​
Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Query Parameters

​
slug
string | null

Filter by slug.

​
page
integer
default:1

Page number, defaults to 1.

​
limit
integer
default:10

Size of a page, defaults to 10. Maximum is 100.

​
sorting
enum<string>[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Available options:
created_at,
-created_at,
slug,
-slug,
name,
-name,
next_review_threshold,
-next_review_threshold,
days_in_status,
-days_in_status

Response

Successful Response

​
items
Organization · object[]
required
​
pagination
Pagination · object
required