GET
/
v1
/
customers
package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Customers.List(ctx, operations.CustomersListRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceCustomer != 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>",
      "metadata": {},
      "email": "<string>",
      "email_verified": true,
      "name": "<string>",
      "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      },
      "tax_id": [
        "<any>"
      ],
      "organization_id": "<string>",
      "avatar_url": "<string>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
organization_id

Filter by organization ID.

​
email
string | null

Filter by exact email.

​
query
string | null

Filter by name or email.

​
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.

Available options:
created_at,
-created_at,
email,
-email,
name,
-name
​
metadata
object | null

Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

Response

200
application/json
Successful Response
​
items
object[]
required
​
pagination
object
required

Was this page helpful?

Get Customer
Previous
Create Customer
Next