Puzzles

Endpoint to retrieve puzzles for a program membership

get

Authorizations

Path parameters

program_membership_idanyrequired

ID of the program membership to retrieve puzzles for

Query parameters

startedanyoptional

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v2/program-memberships/{program_membership_id}/puzzles' \
  --header 'X-API-Key: YOUR_API_KEY'

200

200

{
  "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"
    ]
  }
}

Successful response

Endpoint to retrieve a single puzzle belonging to a program membership

get

Authorizations

Path parameters

puzzle_idanyrequired

ID of the puzzle to retrieve

program_membership_idanyrequired

ID of the program membership to retrieve puzzle for

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v2/program-memberships/{program_membership_id}/puzzles/{puzzle_id}' \
  --header 'X-API-Key: YOUR_API_KEY'

200

200

{
  "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"
    ]
  }
}

Successful response