Skip to content

/api/characters

Retrieve a paginated list of Characters from the database.

Endpoint: GET /api/characters

ParameterTypeDefaultDescription
pageinteger1Page number for pagination
limitinteger20Number of results per page
https://gundam-api.pages.dev/api/characters?page=1&limit=10
{
"info": {
"count": 150,
"pages": 15,
"next": "https://gundam-api.pages.dev/api/characters?page=2",
"prev": null
},
"results": [
{
"id": 1,
"wikiName": "amuro-ray",
"wikiUrl": "https://gundam.fandom.com/wiki/Amuro_Ray",
"name": "Amuro Ray",
"header": "Ace pilot of the RX-78-2 Gundam",
"details": "Amuro Ray is a Newtype and pilot...",
"imgUrl": "https://example.com/amuro.jpg",
"aliases": "White Devil",
"species": "Human (Newtype)",
"bloodType": "A",
"height": "168 cm",
"weight": "55 kg",
"hairColor": "Brown",
"eyeColor": "Brown",
"age": "15",
"birthDate": "U.C. 0059-11-04",
"gender": "Male",
"loveInterests": "Sayla Mass",
"nationality": "Earth Federation",
"affiliation": "Earth Federation Forces",
"occupation": "Mobile Suit Pilot",
"status": "Alive"
}
]
}

Info Object

  • count (integer): Total number of Characters in the database
  • pages (integer): Total number of pages
  • next (string|null): URL for the next page, null if on last page
  • prev (string|null): URL for the previous page, null if on first page

Character Object

  • id (integer): Numeric identifier for the Character
  • wikiName (string): URL-friendly name used as primary key
  • wikiUrl (string): Link to the Character’s wiki page
  • name (string): Display name of the Character
  • header (string|null): Brief description or header text
  • details (string|null): Detailed description of the Character
  • imgUrl (string|null): URL to an image of the Character
  • aliases (string|null): Alternate names or nicknames
  • species (string|null): Species information
  • bloodType (string|null): Blood type
  • height (string|null): Height information
  • weight (string|null): Weight information
  • hairColor (string|null): Hair color
  • eyeColor (string|null): Eye color
  • age (string|null): Age information
  • birthDate (string|null): Birth date
  • gender (string|null): Gender
  • loveInterests (string|null): Known love interests
  • nationality (string|null): Nationality or origin
  • affiliation (string|null): Organizations or factions
  • occupation (string|null): Occupation or role
  • status (string|null): Current status
  • 200 OK: Request successful
  • 500 Internal Server Error: Server error occurred
{
"error": "Failed to fetch characters"
}