Core API
- Checkout
- Checkout Links
- Custom Checkout Fields
- Customers
- Subscriptions
- Orders
- Discounts
- Refunds
- Products
- Benefits
- License Keys
- Files
- Organizations
- Metrics
Customer Portal API
- GETGet Customer
- GETGet Organization
- Sessions
- Subscriptions
- Orders
- License Keys
- File Downloads
Webhook Events
- Billing Events
- Organization Events
OAuth 2.0 API
- Connect
- Clients
List Organizations
List organizations.
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": "<string>",
"name": "<string>",
"slug": "<string>",
"avatar_url": "<string>",
"bio": "<string>",
"company": "<string>",
"blog": "<string>",
"location": "<string>",
"email": "<string>",
"twitter_username": "<string>",
"pledge_minimum_amount": 123,
"pledge_badge_show_amount": true,
"default_upfront_split_to_contributors": 123,
"profile_settings": {
"enabled": true,
"description": "<string>",
"featured_projects": [
"<string>"
],
"featured_organizations": [
"<string>"
],
"links": [
"<string>"
],
"subscribe": {
"promote": true,
"show_count": true,
"count_free": true
},
"accent_color": "<string>"
},
"feature_settings": {
"issue_funding_enabled": false
},
"subscription_settings": {
"allow_multiple_subscriptions": true,
"allow_customer_updates": true,
"proration_behavior": "invoice"
}
}
],
"pagination": {
"total_count": 123,
"max_page": 123
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
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
, name
, -name
Response
Creation timestamp of the object.
Last modification timestamp of the object.
The organization ID.
Settings for the organization profile
If this organization has a profile enabled
A description of the organization
160
A list of featured projects
A list of featured organizations
A list of links associated with the organization
Subscription promotion settings
Accent color for the organization
Settings for the organization features
If this organization has issue funding enabled
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": "<string>",
"name": "<string>",
"slug": "<string>",
"avatar_url": "<string>",
"bio": "<string>",
"company": "<string>",
"blog": "<string>",
"location": "<string>",
"email": "<string>",
"twitter_username": "<string>",
"pledge_minimum_amount": 123,
"pledge_badge_show_amount": true,
"default_upfront_split_to_contributors": 123,
"profile_settings": {
"enabled": true,
"description": "<string>",
"featured_projects": [
"<string>"
],
"featured_organizations": [
"<string>"
],
"links": [
"<string>"
],
"subscribe": {
"promote": true,
"show_count": true,
"count_free": true
},
"accent_color": "<string>"
},
"feature_settings": {
"issue_funding_enabled": false
},
"subscription_settings": {
"allow_multiple_subscriptions": true,
"allow_customer_updates": true,
"proration_behavior": "invoice"
}
}
],
"pagination": {
"total_count": 123,
"max_page": 123
}
}