Puzzles

Endpoint to retrieve puzzles for a program membership

get

Authorizations

Path parameters

program_membership_idstringRequired

ID of the program membership to retrieve puzzles for

Query parameters

startedbooleanOptional

A filter. Set true to only return puzzles where the program membership has made progress. Set false to only return puzzles where the program membership has not made progress. If left blank, all puzzles are returned.

Responses

get

HTTPcURLJavaScriptPython

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

200

Successful response

{
  "puzzle": {
    "id": "text",
    "program_id": 1,
    "name": "text",
    "description": "text",
    "earn_instructions": "text",
    "image_url": "text",
    "status": "text",
    "archived_at": 1,
    "published_at": 1,
    "rewards": [
      "text"
    ]
  }
}

Endpoint to retrieve a single puzzle belonging to a program membership

get

Authorizations

Path parameters

puzzle_idstringRequired

ID of the puzzle to retrieve

program_membership_idstringRequired

ID of the program membership to retrieve puzzle for

Responses

get

HTTPcURLJavaScriptPython

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

200

Successful response

{
  "puzzle": {
    "id": "text",
    "program_id": 1,
    "name": "text",
    "description": "text",
    "earn_instructions": "text",
    "image_url": "text",
    "status": "text",
    "archived_at": 1,
    "published_at": 1,
    "rewards": [
      "text"
    ]
  }
}