Endpoints

Course Endpoints

Course Endpoints

These endpoints provide access to golf course information, including searching, filtering, and detailed course data.

List All Courses

Code
 
GET /courses

Retrieves a paginated list of all golf courses.

Query Parameters

Parameter	Type	Description
page	integer	Page number for pagination (default: 1)
limit	integer	Number of results per page (default: 20, max: 100)
country	string	Filter by country (e.g., "Spain", "Portugal")
region	string	Filter by region (e.g., "Algarve", "Costa del Sol")
bookingCode	string	Filter by booking code (e.g., "AGP", "HRG")

Response

Code
 
{
  "data": [
    {
      "id": "course_123",
      "name": "Marbella Golf Country Club",
      "bookingCode": "AGP",
      "country": "Spain",
      "region": "Costa del Sol",
      "latitude": 36.5092,
      "longitude": -4.8833,
      "courseType": "resort",
      "holesCount": 18,
      "isOnline": true,
      "thumbnailUrl": "https://cdn.golfglobe365.com/prod/course/marbella-golf-thumb.jpg"
    },
    // ... more courses
  ],
  "pagination": {
    "totalItems": 325,
    "totalPages": 17,
    "currentPage": 1,
    "limit": 20
  }
}

Get Course Details

Code
 
GET /courses/{courseId}

Retrieves detailed information about a specific golf course.

Path Parameters

Parameter	Type	Description
courseId	string	Unique identifier for the course

Response

Code
 
{
  "id": "course_123",
  "name": "Marbella Golf Country Club",
  "bookingCode": "AGP",
  "description": "Marbella Golf Country Club is one of the most prestigious and challenging golf courses in the world...",
  "country": "Spain",
  "region": "Costa del Sol",
  "address": {
    "street": "Calle del Golf 1",
    "city": "Marbella",
    "postalCode": "29603",
    "state": "Málaga"
  },
  "contact": {
    "phone": "+34 951 123 456",
    "email": "[email protected]",
    "website": "https://www.marbellagolf.com"
  },
  "location": {
    "latitude": 36.5092,
    "longitude": -4.8833
  },
  "details": {
    "courseType": "resort",
    "holesCount": 18,
    "par": 72,
    "length": {
      "meters": 6789,
      "yards": 7425
    },
    "designer": "Robert Trent Jones",
    "yearBuilt": 1985,
    "grassType": "Bermuda",
    "facilities": [
      "driving_range",
      "putting_green",
      "pro_shop",
      "buggy_rental",
      "club_rental",
      "restaurant"
    ]
  },
  "booking": {
    "isOnline": true,
    "bookingMethod": "online",
    "provider": "golfclix",
    "partnershipStatus": "active_partner"
  },
  "media": {
    "thumbnailUrl": "https://cdn.golfglobe365.com/prod/course/marbella-golf-thumb.jpg",
    "coverImageUrl": "https://cdn.golfglobe365.com/prod/course/marbella-golf-cover.jpg",
    "gallery": [
      "https://cdn.golfglobe365.com/prod/course/marbella-golf-1.jpg",
      "https://cdn.golfglobe365.com/prod/course/marbella-golf-2.jpg"
    ]
  }
}

Search Courses by Name

Code
 
GET /courses/search

Searches for courses by name or partial name match.

Query Parameters

Parameter	Type	Description
query	string	Search query for course name (required)
page	integer	Page number for pagination (default: 1)
limit	integer	Number of results per page (default: 20, max: 100)
country	string	Filter by country

Response

Similar to the List All Courses response, but filtered by the search query.

Search Courses by Booking Code

Code
 
GET /courses/booking-code/{bookingCode}

Finds all courses associated with a specific booking code, typically used for travel agent search.

Path Parameters

Parameter	Type	Description
bookingCode	string	Booking code for the region (e.g., "AGP", "HRG")

Response

Similar to the List All Courses response, but filtered by booking code.

Filter Courses by Attributes

Code
 
GET /courses/filter

Advanced filtering of courses by multiple attributes.

Query Parameters

Parameter	Type	Description
country	string	Filter by country
region	string	Filter by region
courseType	string	Filter by course type (resort, public, private)
holesCount	integer	Filter by number of holes (9, 18)
isOnline	boolean	Filter by online booking availability
facilities	string	Comma-separated list of required facilities
page	integer	Page number for pagination (default: 1)
limit	integer	Number of results per page (default: 20, max: 100)

Response

Similar to the List All Courses response, but filtered by the specified attributes.