1. Lists API
GY Docs
  • Documentation
  • Books API
    • Get Book (Public)
      GET
    • Get Book
      GET
    • List Books by User
      GET
    • Update Book
      PATCH
    • Delete Book
      DELETE
  • Friends API
    • List Friends
      GET
    • Remove Friend
      DELETE
    • Send Friend Request
      POST
    • Manage Friend Request
      POST
    • Get Friend Requests
      GET
  • Profile API
    • List Profiles
      GET
    • List Profiles (Public)
      GET
    • Get Profile
      GET
    • Get Profile (Public)
      GET
    • Update Biography
      PATCH
    • Get Hall of Fame
      GET
    • Add Book to Hall of Fame
      PATCH
    • Delete Book from Hall of Fame
      DELETE
    • Set Quote to Hall of Fame
      PATCH
  • Activity API
    • List Friends Activities
    • List Activities
    • Add Activity
    • React to an Activity
  • Lists API
    • List lists
      GET
    • Get list
      GET
    • Create List
      POST
    • Update List
      PATCH
    • Remove List
      DELETE
    • Save a Book
      POST
    • Update a Book
      PATCH
    • Remove a Book
      DELETE
  • Metadata API
GY AccountsGY Books
Heralds of Chaos
GY AccountsGY Books
Heralds of Chaos
  1. Lists API

Get list

GET
https://api.gycoding.com/books/lists/{id}
Retrieves a list.

Request

Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.gycoding.com/books/lists/' \
--header 'Authorization;'

Responses

🟢200Success
application/json
Body

Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "books": [
        {
            "bookId": "string",
            "order": 0
        }
    ]
}
🟠403Forbidden
🟠404Not Found
🟠405Method Not Allowed
🔴500Internal Error
Previous
List lists
Next
Create List
Built with