List identities
Lists identities that are either uploaded by the authenticated user or belong to groups the user is a member of. Results are paginated. Includes platform-provided default identities based on the user's subscription tier.
token_authAuthorizationBearer <token>Token-based authentication using access tokens.
page?PagePage number.
1per_page?Per PageItems per page.
1 <= value <= 10020order?OrderSort order.
"desc""asc""desc"search?|Search term to filter identities by name.
nullsort_by?Sort BySort by field.
"created_at""name""created_at"ownership?|Filter by ownership: 'mine' for own identities, 'shared' for group members' identities, 'default' for platform identities.
nullcreated_by?|Filter by creator username (exact match). Typically the username of a teammate.
nullinclude_locked?Include LockedWhen true, return all tier identities with a 'locked' field indicating access.
falsestatus?|Filter by preprocessing status (e.g., completed, processing, pending, failed).
nullgender?|Filter by gender from image_description metadata.
nullmin_age?|Minimum age filter (inclusive).
nullmax_age?|Maximum age filter (inclusive).
nulltag?|Filter by tag from image_description metadata (partial match).
nulltag_ids?array<string>|Filter by user-defined tag IDs (OR semantics). Repeat the param: ?tag_ids=a&tag_ids=b.
nullSuccessful Response
application/json- response
identities*array<>pagination*Pagination information for a list of items.
curl -X GET "https://example.com/identity"{ "identities": [ { "preprocessing_status": "string", "visibility": "shared", "groups": [ "string" ], "identity_code": "string", "name": "string", "original_filename": null, "created_by": "string", "image_description": null, "link": "string", "thumbnail_link": null, "created_at": "string", "locked": false, "tier": null, "user_tags": [] } ], "pagination": { "page": 0, "per_page": 0, "total": 0, "pages": 0, "has_next": true, "has_prev": true }}