People

List recognized people

GET
/v1_1/{cloud_name}/people

Returns a list of all recognized people in your product environment. People Search must be enabled for this product environment.

Authorization

AuthorizationBasic <token>

Basic authentication using Cloudinary API Key and API Secret.

In: header

Path Parameters

cloud_name*string

The cloud name of your product environment.

Query Parameters

max_results?integer

The maximum number of people to return. Default: 50.

Range1 <= value <= 100
Default50
next_cursor?string

The cursor for pagination. Use the next_cursor value from a previous response to get the next page of results.

name_status?string

Filter by whether the person has been named. Default: all.

Default"all"

Value in

  • "all"
  • "named"
  • "unnamed"
name_prefix?string

Filter people whose names start with the given prefix (case insensitive).

status?string

Filter by person status.

Value in

  • "active"
  • "hidden"
sort_by?string

The field to sort results by. Default: name (ascending).

Default"name"

Value in

  • "name"
  • "created_at"
  • "updated_at"
direction?string

The sort direction for the results. Default is "desc".

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1_1/my_cloud/people?max_results=20&name_status=named&name_prefix=Alice&status=active&sort_by=created_at"
{  "people": [    {      "id": "string",      "name": "string",      "status": "active",      "thumbnail": {        "asset_id": "string",        "bounding_box": [          0,          0,          0,          0        ],        "url": "http://example.com",        "resource_type": "string",        "type": "string",        "public_id": "string",        "version": 0      },      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}