# Search players

Search the players in a community

Endpoint: GET /v1/players
Version: 1.0
Security: bearerAuth

## Request fields (application/json):

  - `communityId` (integer, required)
    Community Id
    Example: 19564

  - `playerIds` (array)
    List of Player Ids
    Example: [4,2445,2434]

  - `email` (string)
    Email Address
    Example: "support@unknowngolf.com"

  - `lastName` (string)
    Last name can be partial but must start with
    Example: "Trab"

  - `member` (boolean)
    Player member status, True for Members, and false for Non-Members
    Example: true

  - `hcProviderId` (integer)
    World Handicap Provider Id, reference the API for World Handicap Providers for the ids
    Example: 3

  - `hcId` (string)
    Handicap Id
    Example: "15.2"

## Response 200 fields (application/json):

  - `playerId` (integer)
    Player Id
    Example: 15254

  - `member` (boolean)
    Member of community
    Example: true

  - `firstName` (string)
    first name
    Example: "Bill"

  - `lastName` (string)
    last name
    Example: "Trabosh"

  - `suffix` (string)
    suffix
    Example: "III"

  - `gender` (string)
    Gender code
    Example: "M / F"

  - `handle` (string)
    Handle or nickname
    Example: "Founder"

  - `email` (string)
    Email address
    Example: "support@unknowngolf.com"

  - `dob` (string)
    Date of Birth
    Example: "1987-01-26"

  - `phoneCountryCd` (string)
    Country Code for the phone number
    Example: "US"

  - `phone` (string)
    Phone number
    Example: "5555555555"

  - `hcActive` (boolean)
    Flag if the player's world handicap is active
    Example: true

  - `hcProviderId` (integer)
    World Handicap Provider Id, reference the API for World Handicap Providers for the ids
    Example: 3

  - `hcId` (string)
    World Handicap Id
    Example: "6585452"

  - `hcIndex` (number)
    World Handicap Index
    Example: 15.2

  - `hcRevisionDt` (string)
    Handicap revision date
    Example: "2025-04-11"

  - `picUrl` (string)
    Profile Picture URL
    Example: "https://static.unknwongolf.com/example.gif"

  - `updatesAllowed` (boolean)
    Flag if updates to the player's personal information may be made through the Unknown Golf API


If the player has already completed their profile on UnknownGolf.com, updates to the player's personal information listed below can only be performed by the player on Unknown Golf:

- Name (First, Last, Suffix)
- Email Address
- World Handicap Id
- Date of Birth
- Phone Number

Only updates are restricted, if the player does not currently have an attribute set then setting that attribute is allowed.  Example, if the player does not have a phone number set, you can set the phone number for them.
    Example: true