person

Search persons

Platform-wide search over PERSONS (the cross-tenant human identity that accounts hang off), not accounts — requires the cross-tenant grant. This is how you find every account one human holds across tenants and spot a duplicate signup; an account-level search cannot see across tenant boundaries. tenant_id restricts to persons with a live account in that tenant; invited_by restricts to persons with an account invited by a given account id.

get/admin/persons

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/admin/persons
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Query parameters

emailstring

email

phonestring

phone

qstring

free-text query

verified_onlyboolean

verified_only

tenant_idstring

restrict to persons with a live account in this tenant

invited_bystring

restrict to persons with an account invited by this account id

group_idstring uuid

restrict to persons holding a live account that is a member of this group; 404 group_not_found if the group is not visible to you

exclude_group_idstring uuid

drop persons holding a live account in this group; 404 group_not_found if not visible

created_afterstring

RFC3339 lower bound on created_at (inclusive)

created_beforestring

RFC3339 upper bound on created_at (exclusive)

sort'name' | 'name_desc' | 'recent' | 'oldest'

name (A-Z, default) | name_desc | recent | oldest

limitinteger

limit

offsetinteger

offset

Response

OK

limitinteger
offsetinteger
successboolean
totalinteger

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.