Program memberships

Get all program memberships

get

Program Memberships represent a member of the loyalty program. Includes user data. Sorted by creation date.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Query parameters

search_querystringOptional

First name, last name, phone, or email of the users we want to look up.

offsetnumberOptional

Index to start at.

Responses

200

Successful response

application/json

get

/v2/admin/program-memberships

HTTPcURLJavaScriptPython

GET /partner-api/v2/admin/program-memberships HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "program_memberships": [
    {
      "id": "text",
      "first_name": "text",
      "last_name": "text",
      "email": "text",
      "phone": "text",
      "phone_verified": true,
      "created_at": 1,
      "stripe_customer_id": "text"
    }
  ],
  "total_records": 1
}

Get the program membership with the specified Id

get

Program Membership represents a member of the loyalty program. Includes user data.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

program_membership_idnumberRequired

Responses

200

Successful response

application/json

get

/v2/admin/program-memberships/{program_membership_id}

HTTPcURLJavaScriptPython

GET /partner-api/v2/admin/program-memberships/{program_membership_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "program_membership": {
    "id": "text",
    "first_name": "text",
    "last_name": "text",
    "email": "text",
    "phone": "text",
    "phone_verified": true,
    "created_at": 1,
    "stripe_customer_id": "text"
  }
}