Lookups

Lookups

Bracket Levels Lookup

GET
/v1/data/lookup_bracket_levels
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
    "results": [
        {
            "id": "1",
            "title": "Amateur",
            "displayOrder": "1",
            "isEnabled": true,
            "publicDisplayOrder": "4"
        },
        {
            "id": "2",
            "title": "Pro",
            "displayOrder": "5",
            "isEnabled": true,
            "publicDisplayOrder": "1"
        },
        {
            "id": "3",
            "title": "Senior Pro",
            "displayOrder": "15",
            "isEnabled": true,
            "publicDisplayOrder": "2"
        },
        {
            "id": "4",
            "title": "Junior Pro",
            "displayOrder": "25",
            "isEnabled": true,
            "publicDisplayOrder": "3"
        },
        {
            "id": "5",
            "title": "Junior Amateur",
            "displayOrder": "20",
            "isEnabled": true,
            "publicDisplayOrder": "6"
        },
        {
            "id": "6",
            "title": "Senior Amateur",
            "displayOrder": "10",
            "isEnabled": true,
            "publicDisplayOrder": "5"
        }
    ]
}

Formats Lookup

GET
/v1/data/lookup_formats
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
  "results": [
    {
      "id": "1",
      "title": "Doubles",
      "displayOrder": 1,
      "isEnabled": true,
      "partnerNeeded": true,
      "shortHand": "D"
    },
    {
      "id": "2",
      "title": "Singles",
      "displayOrder": 2,
      "isEnabled": true,
      "partnerNeeded": false,
      "shortHand": "S"
    },
    {
      "id": "3",
      "title": "Doubles Blind Draw",
      "displayOrder": 3,
      "isEnabled": true,
      "partnerNeeded": false,
      "shortHand": "D-BLD"
    },
    {
      "id": "6",
      "title": "Skinny Singles",
      "displayOrder": 6,
      "isEnabled": true,
      "partnerNeeded": false,
      "shortHand": "SS"
    },
    {
      "id": "7",
      "title": "Doubles Scramble",
      "displayOrder": 5.5,
      "isEnabled": true,
      "partnerNeeded": false,
      "shortHand": "D-SCR"
    }
  ]
}

Player Groups Lookup

GET
/v1/data/lookup_player_groups
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
    "results": [
        {
            "id": "1",
            "title": "Men",
            "description": "Men Only",
            "displayOrder": 3
        },
        {
            "id": "2",
            "title": "Women",
            "description": "Women Only",
            "displayOrder": 1
        },
        {
            "id": "3",
            "title": "Mixed",
            "description": "One Male One Female",
            "displayOrder": 2
        },
        {
            "id": "4",
            "title": "Coed",
            "description": "Any Combination",
            "displayOrder": 4
        }
    ]
}

Pro Levels Lookup

GET
/v1/data/lookup_pro_levels
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
  "results": [
    {
      "id": "1",
      "title": "Eligible Pro",
      "displayOrder": 3,
      "isEnabled": true,
      "isPro": true
    },
    {
      "id": "2",
      "title": "Senior Pro",
      "displayOrder": 4,
      "isEnabled": true,
      "isPro": true
    },
    {
      "id": "3",
      "title": "Junior Pro",
      "displayOrder": 5,
      "isEnabled": true,
      "isPro": true
    },
    {
      "id": "4",
      "title": "Amateur",
      "displayOrder": 1,
      "isEnabled": true,
      "isPro": false
    },
    {
      "id": "5",
      "title": "UPA Tour Pro",
      "displayOrder": 2,
      "isEnabled": true,
      "isPro": true
    }
  ]
}

Contact Us Reasons Lookup

GET
/v1/data/lookup_contact_us_reasons
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.

Query parameters

NameDescription
tournamentBoolean value for contact reason for tournaments
platformsBoolean value for contact reason for platforms
Request
Empty
Response
{
  "totalRecords": "0",
  "results": [
    {
      "id": "1",
      "name": "Registration",
      "isTournament": true,
      "isPlatform": false
    },
    {
      "id": "2",
      "name": "Referees",
      "isTournament": true,
      "isPlatform": false
    },
    {
      "id": "3",
      "name": "Refund",
      "isTournament": true,
      "isPlatform": false
    },
    {
      "id": "4",
      "name": "Request Partner",
      "isTournament": true,
      "isPlatform": false
    },
    {
      "id": "5",
      "name": "Sponsors",
      "isTournament": true,
      "isPlatform": false
    },
    {
      "id": "6",
      "name": "Vendors",
      "isTournament": true,
      "isPlatform": false
    },
    {
      "id": "7",
      "name": "Volunteer",
      "isTournament": true,
      "isPlatform": false
    },
    {
      "id": "8",
      "name": "My Account",
      "isTournament": true,
      "isPlatform": true
    },
    {
      "id": "9",
      "name": "Other",
      "isTournament": true,
      "isPlatform": true
    },
    {
      "id": "10",
      "name": "Tournament",
      "isTournament": false,
      "isPlatform": true
    },
    {
      "id": "11",
      "name": "League",
      "isTournament": false,
      "isPlatform": true
    },
    {
      "id": "12",
      "name": "Club",
      "isTournament": false,
      "isPlatform": true
    }
  ]
}

Categories Lookup

GET
/v1/data/lookup_categories
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.

Query parameters

NameDescription
is_newsBoolean value to display items for news
is_instructional_videoBoolean value to display items for instructional video
display_orderof title, ascending, descending
is_activebool value
Request
Empty
Response
{
   "results": [
       {
           "id": "1",
           "title": "Dink",
           "isInstructionalVideo": true,
           "isNews": true,
           "isActive": true
       },
...]
}

Countries Lookup

GET
/v1/data/lookup_countries
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.

Query parameters

NameDescription
region_idfor filtering all countries from one region, integer value
Response
{
   "results": [
        {
            "id": "1",
            "abbreviation": "AFG",
            "title": "Afghanistan",
            "internationalCountryCallingCode": "0",
            "stateTitle": "State",
            "zipCodeTitle": "Zip",
            "systemTextNumberId": "",
            "abbreviation2Digit": "AF",
            "region_id" : 0
        },
...]
}

Governing Bodies Lookup

GET
/v1/data/lookup_governing_bodies
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
    "results": [
        {
            "id": "1",
            "name": "Pro Pickleball Association",
            "shortName": "PPA",
            "isActive": true,
            "isSearchFilter": true,
            "filterSearchParam": "sanction_ppa",
            "displayOrder": 1,
            "url": "",
            "clubId": "80f17003-cd92-4fc4-84e4-06d38e096042",
            "logoUrl": ""
        },
        {
            "id": "10",
            "name": "Major League Pickleball",
            "shortName": "MLP",
            "isActive": true,
            "isSearchFilter": true,
            "filterSearchParam": "sanction_mlp",
            "displayOrder": 2,
            "url": "",
            "clubId": "f6f5296b-b9a6-4d25-a295-29f461de56d2",
            "logoUrl": ""
        },
        {
            "id": "2",
            "name": "Association of Pickleball Professionals",
            "shortName": "APP",
            "isActive": true,
            "isSearchFilter": true,
            "filterSearchParam": "sanction_app",
            "displayOrder": 3,
            "url": "",
            "clubId": "51e3befa-85f0-46c5-b776-7a7d5241fc37",
            "logoUrl": ""
        },
        {
            "id": "3",
            "name": "Pickleball Canada Organization",
            "shortName": "PCO",
            "isActive": true,
            "isSearchFilter": true,
            "filterSearchParam": "sanction_pco",
            "displayOrder": 4,
            "url": "https://pickleballcanada.org/membership/join-renew/",
            "clubId": "",
            "logoUrl": "https://images.pickleball.com/governing_bodies/pco.png"
        },
        {
            "id": "7",
            "name": "Pickleball Australia Association",
            "shortName": "PAA",
            "isActive": true,
            "isSearchFilter": true,
            "filterSearchParam": "sanction_paa",
            "displayOrder": 5,
            "url": "https://www.pickleballaus.org/membership",
            "clubId": "2fb32e18-580c-433a-8d7d-4ad032c45b51",
            "logoUrl": "https://images.pickleball.com/governing_bodies/paa.png"
        },
        {
            "id": "13",
            "name": "Legacy Sports USA",
            "shortName": "LSUSA",
            "isActive": true,
            "isSearchFilter": true,
            "filterSearchParam": "sanction_lsusa",
            "displayOrder": 6,
            "url": "",
            "clubId": "",
            "logoUrl": ""
        },
        {
            "id": "11",
            "name": "World Pickleball Tour",
            "shortName": "WPT",
            "isActive": true,
            "isSearchFilter": true,
            "filterSearchParam": "sanction_wpt",
            "displayOrder": 7,
            "url": "",
            "clubId": "",
            "logoUrl": ""
        },
        {
            "id": "12",
            "name": "National Pickleball",
            "shortName": "NP",
            "isActive": true,
            "isSearchFilter": true,
            "filterSearchParam": "sanction_np",
            "displayOrder": 8,
            "url": "",
            "clubId": "",
            "logoUrl": ""
        },
        {
            "id": "14",
            "name": "Newport Beach Pickleball",
            "shortName": "NBP",
            "isActive": true,
            "isSearchFilter": true,
            "filterSearchParam": "sanction_nbp",
            "displayOrder": 9,
            "url": "",
            "clubId": "",
            "logoUrl": ""
        },
        {
            "id": "5",
            "name": "USA Pickleball",
            "shortName": "USAP",
            "isActive": true,
            "isSearchFilter": true,
            "filterSearchParam": "sanction_usapa",
            "displayOrder": 10,
            "url": "https://usapickleball.org/memberships/",
            "clubId": "dbe502ad-9463-48a5-9808-23040361c613",
            "logoUrl": "https://images.pickleball.com/governing_bodies/USAPA.png"
        },
        {
            "id": "6",
            "name": "US Senior Pickleball",
            "shortName": "USSP",
            "isActive": true,
            "isSearchFilter": true,
            "filterSearchParam": "sanction_ssipa",
            "displayOrder": 11,
            "url": "https://www.memberleap.com/members/mlogin.php?org_id=SSIP&bounce=%2Fmembers%2Fmembers.php%3Forgcode%3DSSIP",
            "clubId": "16ce92c6-eeb5-4b68-9b9c-87bf57ceb855",
            "logoUrl": "https://images.pickleball.com/governing_bodies/ussp.jpg"
        },
        {
            "id": "4",
            "name": "Georgia Pickleball Association",
            "shortName": "GPA",
            "isActive": true,
            "isSearchFilter": true,
            "filterSearchParam": "sanction_gpa",
            "displayOrder": 13,
            "url": "",
            "clubId": "",
            "logoUrl": "https://images.pickleball.com/governing_bodies/sp.png"
        },
        {
            "id": "15",
            "name": "Life Time Pickleball",
            "shortName": "LTP",
            "isActive": true,
            "isSearchFilter": true,
            "filterSearchParam": "sanction_ltp",
            "displayOrder": 15,
            "url": "",
            "clubId": "",
            "logoUrl": "https://images.pickleball.com/governing_bodies/ltp.png"
        }
    ]
}

Platforms Lookup

GET
/v1/data/lookup_platforms
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
   "results": [
       {
           "id": "1",
           "name": "Pickleball Brackets",
           "domain": "https://pickleballinc.com/",
           "apiKey": "2023-09-11T19:28:58.244013984Z",
           "users": [],
           "isActive": true
       },
...]
}

Ratings Lookup

GET
/v1/data/lookup_ratings
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
   "results": [
       {
           "id": "1",
           "title": "1",
           "from": 1,
           "to": 1.49999999,
           "selfStartPoint": 1.25,
           "hierarchy": 1,
           "isEnabled": true
       },
...]
}

Ranking Divisions Lookup

GET
/v1/data/lookup_ranking_divisions
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
   "results": [
       {
            "id": "1",
            "title": "Men's Doubles",
            "displayOrder": 0,
            "isActive": true
        },
...]
}

States Lookup

GET
/v1/data/lookup_states
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.

Query parameters

NameDescription
country_idFor filltering all states from country
Request
Empty
Response
{
   "results": [
       {
           "id": "1",
           "abbreviation": " ",
           "title": "Andaman and Nicobar Islands",
           "countryId": "132"
       },
...]
}

Timezones Lookup

GET
/v1/data/lookup_timezones
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
   "results": [
{
            "id": "10",
            "utcOffset": -5,
            "name": "Afghanistan",
            "abbreviation": "AFT",
            "fullName": "Afghanistan Standard Time",
            "hasDst": false,
            "ianaTzIdentifier": "Asia/Kabul",
            "daylightChange": null,
            "nonDaylightChange": null,
            "daylightSavingAbbreviation": "",
            "daylightSavingUtcOffset": 0
        },
...]
}

Where To Watch Event Types Lookup

GET
/v1/data/lookup_where_to_watch_event_types
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
   "results": [
        {
            "id": "1",
            "title": "M/W Singles",
            "displayOrder": 0,
            "isActive": true
        },
...]
}

Where To Watch Channels Lookup

GET
/v1/data/lookup_where_to_watch_channels
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
   "results": [
       {
            "id": "1",
            "title": "Tennis Channel",
            "displayOrder": 0,
            "isActive": true,
            "url": ""
        },
...]
}

Amenity Types Lookup

GET
/v1/data/lookup_amenity_types
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
  "results": [
    {
      "id": "1",
      "title": "Lodging",
      "isEnabled": true,
      "displayOrder": 1
    },
    {
      "id": "2",
      "title": "Car Rental",
      "isEnabled": true,
      "displayOrder": 2
    },
    {
      "id": "3",
      "title": "Airline",
      "isEnabled": true,
      "displayOrder": 3
    }
  ]
}

System Text Numbers Lookup

GET
/v1/data/lookup_system_text_numbers
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
  "results": [
    {
      "id": "1",
      "phoneNumber": "18449990071",
      "isEnabled": true,
      "textPlatform": "twilio"
    },
    {
      "id": "2",
      "phoneNumber": "18449990071",
      "isEnabled": true,
      "textPlatform": "twilio"
    },
    {
      "id": "3",
      "phoneNumber": "17162208422",
      "isEnabled": false,
      "textPlatform": "twilio"
    }
  ]
}

Module Types Lookup

GET
/v1/data/lookup_module_types
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
  "results": [
    {
      "id": "1",
      "title": "Clubs"
    },
    {
      "id": "2",
      "title": "Tournaments"
    },
    {
      "id": "3",
      "title": "Leagues"
    },
    {
      "id": "4",
      "title": "Clinics"
    }
  ]
}

User Equipment Types Lookup

GET
/v1/data/lookup_equipment_types
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
  "results": [
    {
      "id": "1",
      "title": "Paddle",
      "isActive": true
    },
    {
      "id": "2",
      "title": "Shoe",
      "isActive": true
    },
    {
      "id": "3",
      "title": "Bag",
      "isActive": true
    },
    {
      "id": "4",
      "title": "Shirt",
      "isActive": true
    },
    {
      "id": "5",
      "title": "Shorts",
      "isActive": true
    },
    {
      "id": "6",
      "title": "Socks",
      "isActive": true
    },
    {
      "id": "7",
      "title": "Grip",
      "isActive": true
    },
    {
      "id": "8",
      "title": "Ball",
      "isActive": true
    },
    {
      "id": "9",
      "title": "Nets",
      "isActive": true
    },
    {
      "id": "10",
      "title": "Training",
      "isActive": true
    }
  ]
}

Tier Rankings Levels Lookup

GET
/v1/data/lookup_rankings_tier_levels
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
    "results": [
        {
            "uuid": "1dd1be30-935f-4b80-afff-278473f0f242",
            "tierName": "PPA 2000"
        },
        {
            "uuid": "4bc18ae4-f80b-4d0b-af0b-9b26161fd7ae",
            "tierName": "PPA 500"
        },
        {
            "uuid": "8afa32ff-f398-4ea4-ab41-8431c092a7b1",
            "tierName": "PPA 1500"
        },
        {
            "uuid": "f2a0b9f8-8a89-4fa0-928a-92c195b54f08",
            "tierName": "PPA 1000"
        }
    ]
}

Currencies Lookup

GET
/v1/data/lookup_currencies
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
    "results": [
        {
            "id": "1",
            "title": "US Dollar",
            "abbreviation": "USD"
        },
        {
            "id": "2",
            "title": "Canadian Dollar",
            "abbreviation": "CAD"
        }
    ]
}

Lookup User Email

GET
/v1/data/user-email-lookup/{email}
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
    "valid": false,
    "masked_phone_number": "*** **** 2386"
}
 
200 OK if the Email is in use 
 
204 Content not found if email is not in use

Roles Lookup

GET
/v1/data/lookup_roles
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
    "userRoles": [
        {
            "id": "7",
            "title": "ADMIN",
            "inheritedIds": "1,4,5,6"
        },
        {
            "id": "14",
            "title": "NEWS_ADMIN",
            "inheritedIds": "1,7"
        },
        {
            "id": "1",
            "title": "USER",
            "inheritedIds": ""
        }
    ]
}

Push Notifications Lookup

GET
/v1/data/lookup_push_notifications
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
    "notifications": [
        {
            "id": "1",
            "title": "You have been invited to game!",
            "description": "You have been invited to a pickleball game!"
        }
    ],
    "totalNotifications": "1"
}

Region Lookup

GET
/v1/data/lookup_regions
💡
This request requires “PB-API-TOKEN” from the platforms.
Request
Empty
Response
{
   "results": [
        {
            "id": "1",
            "title": "Europe",
            "displayOrder”:2
        },
...]
}
LocationsManager Flat Data Search