CorebanqCorebanq Developer Docs
Personasv2Personal Identity

List personas (v2)

Retrieve personas with search, sort, pagination and stack support

GET/v2/personas

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer
offset?integer
sort?string

Comma-separated sort fields. Prefix with '-' for descending, e.g. -created_at

stack?string

Optional stack field, e.g. active or created_at:month

search?string

JSON-encoded search object

search.id.eq?string

Filter by persona ID

search.created_at.eq?string

Filter by created_at (date-time)

search.created_by.eq?string

Filter by created_by

search.modified_at.eq?string

Filter by modified_at (date-time)

search.modified_by.eq?string

Filter by modified_by

search.active.eq?boolean

Filter by active flag

search.metadata.like?string

Search in metadata JSON as text

search.first_name.like?string

Filter by first name

search.last_name.like?string

Filter by last name

search.date_of_birth.eq?string

Filter by date of birth

search.date_of_death.eq?string

Filter by date of death

search.nationality.eq?string

Filter by nationality

search.hash_id.like?string

Filter by hash_id

search.linked_to.record_id?string

Filter personas linked to a specific record ID

search.linked_to.record_type?string

Filter personas linked to a specific record type (e.g. users, customers)

Response Body

application/json

curl -X GET "https://example.com/v2/personas"
{
  "data": [
    {
      "first_name": "string",
      "last_name": "string",
      "date_of_birth": "2019-08-24",
      "date_of_death": "2019-08-24",
      "nationality": "string",
      "hash_id": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "active": true,
      "metadata": {},
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
      "modified_at": "2019-08-24T14:15:22Z",
      "modified_by": "e8d4374d-93a1-4e98-a6c6-fdcf00c5059f"
    }
  ],
  "total": 0,
  "total_unfiltered": 0,
  "keys": [
    "string"
  ],
  "has_more": true
}