List Members

List members with optional customer ID filter.

Scopes: members:read members:write

GET /v1/members

Go (SDK)

Go

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.Members.ListMembers(ctx, operations.MembersListMembersRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceMember != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

200

{
  "items": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "email": "<string>",
      "name": "Jane Doe",
      "external_id": "usr_1337"
    }
  ],
  "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

customer_id · string | null

Filter by customer ID.

external_customer_id · string | null

Filter by customer external ID. The customer external ID.

role · enum<string> | null

Filter by member role.

Available options: owner, billing_manager, member

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

Response

200

application/json

Successful Response

items · Member · object[] · required

Show child attributes

pagination · Pagination · object · required

Show child attributes