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-based authentication using access tokens.
In: header
Query Parameters
Page number.
1Items per page.
201 <= value <= 100Sort order.
"desc""asc" | "desc"Search term to filter identities by name.
nullSort by field.
"created_at""name" | "created_at"Filter by ownership: 'mine' for own identities, 'shared' for group members' identities, 'default' for platform identities.
nullWhen true, return all tier identities with a 'locked' field indicating access.
falseFilter by preprocessing status (e.g., completed, processing, pending, failed).
nullFilter by gender from image_description metadata.
nullMinimum age filter (inclusive).
nullMaximum age filter (inclusive).
nullFilter by tag from image_description metadata (partial match).
nullResponse Body
Examples
curl -X GET "https://v2.api.piktid.com/identity?page=1&per_page=20&order=asc&sort_by=name&include_locked=false"{
"identities": [
{
"preprocessing_status": "string",
"visibility": "shared",
"groups": [
"string"
],
"identity_code": "string",
"name": "string",
"original_filename": null,
"created_by": "string",
"image_description": null,
"link": "string",
"created_at": "string",
"locked": false,
"tier": null
}
],
"pagination": {
"page": 0,
"per_page": 0,
"total": 0,
"pages": 0,
"has_next": true,
"has_prev": true
}
}{
"error": "Invalid request",
"detail": [
{
"field": null,
"message": "string",
"position": "query"
}
]
}