Sign in
People

Get all people

Changed on

Retrieve a list of all people.

get/people

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/people
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Query parameters

closestAssetIdstring uuid

Closest asset ID for similarity search

closestPersonIdstring uuid

Closest person ID for similarity search

pageinteger

Page number for pagination

sizeinteger

Number of items per page

withHiddenboolean

Include hidden people

Response

hasNextPageboolean

Whether there are more pages

hiddeninteger required

Number of hidden people

totalinteger required

Total number of people

Changes

  • 2cd7bd44a940Revision changes
    • info

      the // response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

  • 446a035db458Revision changes
    • breaking

      for the query request parameter page, the type changed from number to integer

    • breaking

      for the query request parameter size, the type changed from number to integer

    • warning

      for the query request parameter page, the max was set to 9007199254740991.00