Clan V2

Clan Details

POST https://api.munzee.com/clan/v2

Headers

Name	Type	Description
Authorization	string	Munzee API Authorization token

Request Body

Name	Type	Description
clan_id	integer	Clan ID

200 Cake successfully retrieved.

Your Clan

{
  "data": {
    "details": {
      "clan_id": 1349,
      "name": "The Cup of Coffee Clan",
      "simple_name": "thecupofcoffeeclan",
      "tagline": "A Stronger Brew",
      "created_by_userid": 125914,
      "logo": "https://munzee.global.ssl.fastly.net/images/clan_logos/11h.png",
      "privacy": "private",
      "goal": "Level 5",
      "members": 10
    },
    "users": [
      {
        "user_id": "8736",
        "username": "TecmjrB",
        "is_admin": "1"
      },
      {
        "user_id": "49731",
        "username": "Benandlou",
        "is_admin": "1"
      },
      {
        "user_id": "51311",
        "username": "Thegenie18",
        "is_admin": "1"
      },
      {
        "user_id": "75621",
        "username": "boompa",
        "is_admin": "0"
      },
      {
        "user_id": "125914",
        "username": "sohcah",
        "is_admin": "1"
      },
      {
        "user_id": "134480",
        "username": "Babydane",
        "is_admin": "1"
      },
      {
        "user_id": "138902",
        "username": "Maxi72",
        "is_admin": "1"
      },
      {
        "user_id": "148677",
        "username": "WriteAndMane",
        "is_admin": "1"
      },
      {
        "user_id": "182382",
        "username": "purplecourgette",
        "is_admin": "1"
      },
      {
        "user_id": "346263",
        "username": "Sidcup",
        "is_admin": "1"
      }
    ],
    "admins": {
      "8736": {
        "user_id": "8736",
        "username": "TecmjrB",
        "is_admin": "1"
      },
      "49731": {
        "user_id": "49731",
        "username": "Benandlou",
        "is_admin": "1"
      },
      "51311": {
        "user_id": "51311",
        "username": "Thegenie18",
        "is_admin": "1"
      },
      "125914": {
        "user_id": "125914",
        "username": "sohcah",
        "is_admin": "1"
      },
      "134480": {
        "user_id": "134480",
        "username": "Babydane",
        "is_admin": "1"
      },
      "138902": {
        "user_id": "138902",
        "username": "Maxi72",
        "is_admin": "1"
      },
      "148677": {
        "user_id": "148677",
        "username": "WriteAndMane",
        "is_admin": "1"
      },
      "182382": {
        "user_id": "182382",
        "username": "purplecourgette",
        "is_admin": "1"
      },
      "346263": {
        "user_id": "346263",
        "username": "Sidcup",
        "is_admin": "1"
      }
    },
    "result": {
      "game_id": 81,
      "level_reached": 0,
      "updated_at": 1575467517,
      "total_value": 74348,
      "rank": 95
    },
    "pending_requests": [],
    "pending_invitations": []
  }
}

Other Clan

Clan List

POST https://api.munzee.com/clan/v2/list

Headers

Name	Type	Description
Authorization	string	Munzee API Authorization token

Request Body

Name	Type	Description
goal	integer	Clan Goal Level (Not sure how this works)

200

{
  "data": {
    "clans": [
      {
        "id": 159,
        "name": "Paris 94",
        "simple_name": "paris94",
        "tagline": "",
        "goal": "Casual Clan",
        "level_reached": 0,
        "members": 9,
        "privacy": "private",
        "pending_request": 0,
        "logo": "https://munzee.global.ssl.fastly.net/images/clan_logos/4f.png"
      }
    ]
  }
}

Clan Search

POST https://api.munzee.com/clan/v2/search

Headers

Name	Type	Description
Authorization	string	Munzee API Authorization token

Request Body

Name	Type	Description
text	string	Search Query String
limit	integer	Results Limit

200

{
  "data": {
    "clans": [
      {
        "id": 457,
        "name": "The Cup Of Tea Clan",
        "simple_name": "thecupofteaclan",
        "tagline": "Just For Fun!",
        "goal": "Casual Clan",
        "level_reached": 0,
        "members": 10,
        "privacy": "private",
        "pending_request": 0,
        "logo": "https://munzee.global.ssl.fastly.net/images/clan_logos/cp.png"
      },
      {
        "id": 1349,
        "name": "The Cup of Coffee Clan",
        "simple_name": "thecupofcoffeeclan",
        "tagline": "A Stronger Brew",
        "goal": "Level 5",
        "level_reached": 0,
        "members": 10,
        "privacy": "private",
        "pending_request": 0,
        "logo": "https://munzee.global.ssl.fastly.net/images/clan_logos/11h.png"
      },
      {
        "id": 1441,
        "name": "The Cup Of Cocoa Clan",
        "simple_name": "thecupofcocoaclan",
        "tagline": "Time to relax",
        "goal": "Casual Clan",
        "level_reached": 0,
        "members": 10,
        "privacy": "private",
        "pending_request": 0,
        "logo": "https://munzee.global.ssl.fastly.net/images/clan_logos/141.png"
      }
    ],
    "too_many": 0
  }
}

Random Clan

POST https://api.munzee.com/clan/v2/random

Headers

Name	Type	Description
Authorization	string	Munzee API Authorization token

Request Body

Name	Type	Description
privacy	string	Clan Privacy Level

200

// See "Clan Details"

Clan Leaderboard

POST https://api.munzee.com/clan/v2/leaderboard

Headers

Name	Type	Description
Authorization	string	Munzee API Authorization token

Request Body

Name	Type	Description
game_id	integer	Starting from 79 (October 2019)

200

{
  "data": {
    "battle": {
      "game_id": 79,
      "start": 1570078860,
      "end": 1572584460,
      "reveal_at": 1569682800,
      "lb_total_task_id": 3,
      "lb_total_key": "Total Points",
      "total_clans": 1025
    },
    "leaderboard": [
      {
        "level_reached": 6,
        "clan_id": 791,
        "lb_total": 9070246,
        "name": "FMH SuperChuckers ONE",
        "simple_name": "flmunzeehuntersuperchuckers",
        "rank": 1,
        "logo": "https://munzee.global.ssl.fastly.net/images/clan_logos/lz.png"
      }
    ]
  }
}

Clan Requirements and Progress

POST https://api.munzee.com/clan/v2/requirements

Headers

Name	Type	Description
Authorization	string	Munzee API Authorization token

Request Body

Name	Type	Description
clan_id	integer	Clan ID
game_id	integer	Starting from 79 (October 2019)

200

{
  "data": {
    "level_reached": 6,
    "updated_at": 1572587630,
    "data": {
      "levels": {
        "1": {
          "individual": [
            {
              "id": 579,
              "task_id": 1,
              "name": "Days of Activity",
              "amount": 2,
              "description": "Capture or deploy a munzee to register activity for the day. Does not have to be in a row. (Excludes Social Munzees)",
              "logo": "https://munzee.global.ssl.fastly.net/images/clan_tasks/1.png",
              "data": {
                "8736": 29,
                "49731": 29,
                "51311": 29,
                "75621": 26,
                "125914": 29,
                "134480": 29,
                "138902": 27,
                "182382": 29,
                "307029": 29,
                "346263": 29
              },
              "completed": 1,
              "percent_completed": 100
            }
          ],
          "group": [
            {
              "id": 645,
              "task_id": 2,
              "name": "Total Captures",
              "amount": 555,
              "description": "Capture any type of munzee.",
              "logo": "https://munzee.global.ssl.fastly.net/images/clan_tasks/group/2.png",
              "data": {
                "8736": 3410,
                "49731": 839,
                "51311": 1307,
                "75621": 1504,
                "125914": 1171,
                "134480": 1962,
                "138902": 2682,
                "182382": 4459,
                "307029": 2278,
                "346263": 1009
              },
              "value": 20621,
              "completed": 1,
              "percent_completed": 100
            }
          ],
          "completed": 1,
          "percent_completed": 100
        },
        "6": {
          "individual": [
            {
              "id": 584,
              "task_id": 9999999,
              "name": "Hidden Task",
              "amount": 1,
              "description": "-CLASSIFIED-",
              "logo": "https://munzee.global.ssl.fastly.net/images/clan_tasks/3.png",
              "data": {
                "8736": 1,
                "49731": 1,
                "51311": 1,
                "75621": 1,
                "125914": 1,
                "134480": 1,
                "138902": 1,
                "182382": 1,
                "307029": 1,
                "346263": 1
              },
              "completed": 1,
              "percent_completed": 100
            }
          ],
          "group": [
            {
              "id": 650,
              "task_id": 9999999,
              "name": "Hidden Task",
              "amount": 10,
              "description": "-CLASSIFIED-",
              "logo": "https://munzee.global.ssl.fastly.net/images/clan_tasks/3.png",
              "data": {
                "8736": 1,
                "49731": 1,
                "51311": 1,
                "75621": 1,
                "125914": 1,
                "134480": 1,
                "138902": 1,
                "182382": 1,
                "307029": 1,
                "346263": 1
              },
              "value": 10,
              "completed": 1,
              "percent_completed": 100
            }
          ],
          "hidden": 1,
          "completed": 1,
          "percent_completed": 100
        }
      }
    },
    "battle": {
      "game_id": 79,
      "start": 1570078860,
      "end": 1572584460,
      "reveal_at": 1569682800,
      "lb_total_task_id": 3
    }
  }
}