Core API
- Checkout
- Checkout Links
- Custom Checkout Fields
- Customers
- Subscriptions
- Orders
- Discounts
- Refunds
- Products
- Events
- Meters
- Benefits
- Customer Meters
- License Keys
- Files
- Organizations
- Metrics
Customer Portal API
- GETGet Customer
- GETGet Organization
- Sessions
- Subscriptions
- Orders
- License Keys
- File Downloads
Webhook Events
- Customer Events
- Billing Events
- Organization Events
OAuth 2.0 API
- Connect
- Clients
List Organizations
List organizations.
Scopes: organizations:read
organizations:write
package main
import(
"context"
"os"
polargo "github.com/polarsource/polar-go"
"log"
)
func main() {
ctx := context.Background()
s := polargo.New(
polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
)
res, err := s.Organizations.List(ctx, nil, nil, nil, nil)
if err != nil {
log.Fatal(err)
}
if res.ListResourceOrganization != nil {
for {
// handle items
res, err = res.Next()
if err != nil {
// handle error
}
if res == nil {
break
}
}
}
}
{
"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
You can generate an Organization Access Token from your organization's settings.
Query Parameters
Filter by slug.
Page number, defaults to 1.
x > 0
Size of a page, defaults to 10. Maximum is 100.
x > 0
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.
created_at
, -created_at
, slug
, -slug
, name
, -name
Response
Creation timestamp of the object.
Last modification timestamp of the object.
The organization ID.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Organization name shown in checkout, customer portal, emails etc.
Unique organization slug in checkout, customer portal and credit card statements.
Avatar URL shown in checkout, customer portal, emails etc.
Public support email.
Official website of the organization.
When the business details were submitted.
Was this page helpful?
package main
import(
"context"
"os"
polargo "github.com/polarsource/polar-go"
"log"
)
func main() {
ctx := context.Background()
s := polargo.New(
polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
)
res, err := s.Organizations.List(ctx, nil, nil, nil, nil)
if err != nil {
log.Fatal(err)
}
if res.ListResourceOrganization != nil {
for {
// handle items
res, err = res.Next()
if err != nil {
// handle error
}
if res == nil {
break
}
}
}
}
{
"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
}
}