GET
/
v1
/
organizations
/
from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.organizations.list(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()
{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
      "name": "<string>",
      "slug": "<string>",
      "avatar_url": "<string>",
      "email": "<string>",
      "website": "<string>",
      "socials": [
        {
          "platform": "x",
          "url": "<string>"
        }
      ],
      "details_submitted_at": "2023-11-07T05:31:56Z",
      "feature_settings": {
        "issue_funding_enabled": false,
        "usage_based_billing_enabled": false
      },
      "subscription_settings": {
        "allow_multiple_subscriptions": true,
        "allow_customer_updates": true,
        "proration_behavior": "invoice"
      }
    }
  ],
  "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.

Required range: x > 0
​
limit
integer
default:10

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

Required range: x > 0
​
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.

Response

200
application/json

Successful Response

The response is of type object.