Identities
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.
AuthorizationBearer <token>
Token-based authentication using access tokens.
In: header
Query Parameters
page?Page
Page number.
Default
1per_page?Per Page
Items per page.
Default
20Range
1 <= value <= 100order?Order
Sort order.
Default
"desc"Value in
"asc" | "desc"search?Search
Search term to filter identities by name.
Default
nullsort_by?Sort By
Sort by field.
Default
"created_at"Value in
"name" | "created_at"Response Body
Examples
curl -X GET "https://v2.api.piktid.com/identity?page=1&per_page=20&order=asc&sort_by=name"{
"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"
}
],
"pagination": {
"page": 0,
"per_page": 0,
"total": 0,
"pages": 0,
"has_next": true,
"has_prev": true
}
}Empty
Empty