POpolar
customers
members
public

Get Member by External ID

Get a member by external ID for a customer identified by its external ID.

Scopes: members:read members:write

get/v1/customers/external/{external_id}/members/{member_external_id}

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/customers/external/{external_id}/members/{member_external_id}
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: members:read, members:write)
    • or HTTP bearer
    • or HTTP bearer

Path parameters

external_idstring required

The customer external ID.

member_external_idstring required

The member external ID.

Response

Member retrieved.

idstring uuid4 required

The ID of the member.

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

customer_idstring uuid4 required

The ID of the customer this member belongs to.

emailstring required

The email address of the member.

namestring nullable required

The name of the member.

external_idstring nullable required

The ID of the member in your system. This must be unique within the customer.

role'owner' | 'billing_manager' | 'member' required

Example response

{
  "email": "member@example.com",
  "name": "Jane Doe",
  "external_id": "usr_1337"
}

Changes

No recorded changes to this operation across all 11 revisions of this API.