Skip to content
EyesOnItDocumentation6.1

Query Face Identities

GET /api/v1/face-directory/identities

Access

Section titled “Access”

Authentication options declared in the contract include user cookie session or bearer service token.

The shared authentication policy requires identities:read. Resource access also depends on the caller’s role, organization, camera grants, and the operation’s validation.

Authentication and permissions explains tokens, cookies, CSRF, and workspace context.

Parameters

Section titled “Parameters”
Name Location Required Type Description and constraints
query query No string maximum length 128. default ""
externalId query No string or null
groupIds query No array of string (uuid) or null
groupMatch query No string values "any", "all". default "any"
unassigned query No boolean default false
hasSamples query No boolean or null
sort query No string values "displayName", "externalId". default "displayName"
descending query No boolean default false
limit query No integer minimum 1. maximum 200. default 50
cursor query No string or null
X-EyesOnIt-Session-Id header No string (uuid) The sessionId the caller expects. Required when switching workspaces and for cookie requests after workspace rotation. A mismatched value returns 409 with X-EyesOnIt-Workspace-Changed: 1. Bootstrap with getCurrentPrincipal; never replay a mutation automatically after changing context. Bearer clients do not use this header.

cURL request template

Section titled “cURL request template”

Set the connection variables described in Get started. Replace each additional EOI_… variable with the parameter value for this request. This template sends the request when run.

Terminal window
curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \
  "${EOI_API_BASE_URL}/face-directory/identities"

Contract responses

Section titled “Contract responses”

The table records responses declared by the OpenAPI contract. See Errors and status codes for the runtime error envelope and shared failures.

Status Description Media type Body
200 Successful Response application/json FaceIdentityPageResponse
422 Validation Error application/json HTTPValidationError

Operation identifier queryFaceIdentities. Browse Identities and samples.

Image preview