people

Get person details.

Changed on

This endpoint will retrieve the details for a person.

get/people/{personID}

Request

  • Base URL
    https://api.kurozora.app/v1
  • URL
    https://api.kurozora.app/v1/people/{personID}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

personIDinteger required

ID of the person.

Query parameters

include[]string[]

The relations to include in the response.

Response

Successful GET People Details JSON response

object required

Example response

{
  "data": [
    {
      "id": 1,
      "type": "people",
      "href": "/v1/people/1",
      "attributes": {
        "firstName": "Alvera",
        "lastName": null,
        "givenName": null,
        "familyName": "中村",
        "alternativeNames": [
          "sunt"
        ],
        "about": null,
        "imageURL": "https://via.placeholder.com/640x480.png/009955?text=et",
        "websiteURL": null
      }
    }
  ]
}

Changes