Skip to main content

Get Identity

Returns the full record for a single person — names, addresses, tags, entity-field attributes, and notes — by their personId.

API Endpoint

  • HTTP Method: GET
  • Endpoint: /api/v1/people/{personId}
  • Base URL (Cloud): https://customername.econnectcloud.com/identities
  • Base URL (On-prem): https://<server-host-or-ip>:5009

Authentication

Requires a JWT bearer token. See Authentication.

Minimum Permission

The permission name and category below are what you'll see in the Identities web app under System → System settings → Roles.

PermissionCategory
Read All IdentityIdentities

Path Parameter

ParameterTypeDescription
personIdstring (GUID)The person's unique identifier.

Code Examples

API_URL="https://customername.econnectcloud.com/identities"
TOKEN="your_jwt"
PERSON_ID="0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d"

curl -sk -X GET "$API_URL/api/v1/people/$PERSON_ID" \
-H "Authorization: Bearer $TOKEN" | jq

Response

200 OK — an IdentityPersonItem:

{
"personId": "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
"aliases": [
{
"personAliasId": "1f2e3d4c-5b6a-7980-1234-56789abcdef0",
"firstName": "Jane",
"lastName": "Doe",
"middleName": null,
"title": null
}
],
"addresses": [
{
"personAddressId": "2a3b4c5d-6e7f-8091-2345-6789abcdef01",
"street": "123 Main St",
"street2": null,
"city": "Las Vegas",
"state": "NV",
"postalCode": "89101",
"country": "USA"
}
],
"entityFields": [
{
"entityFieldId": "3b4c5d6e-7f80-9123-4567-89abcdef0123",
"name": "LoyaltyTier",
"stringValue": "Gold",
"dateValue": null,
"numberValue": null,
"boolValue": null
}
],
"tags": [
{
"tagId": "4c5d6e7f-8091-2345-6789-abcdef012345",
"expires": null,
"created": "2026-01-15T12:00:00Z"
}
],
"notes": [
{
"noteId": "5d6e7f80-9123-4567-89ab-cdef01234567",
"summary": "VIP",
"body": "Prefers window seating",
"author": "host@venue.com",
"sharedId": null
}
]
}

Response Fields

FieldTypeDescription
personIdstring (GUID)The person's identifier.
aliases[]arrayNames: firstName, lastName, middleName, title. The first alias is the primary name.
addresses[]arrayPostal addresses.
entityFields[]arrayCustom attributes — name plus one of stringValue / dateValue / numberValue / boolValue.
tags[]arrayApplied tags — tagId, expires, created.
notes[]arrayFree-text notes — summary, body, author.
Tag names

A person's tags[] contain only the tagId (plus expires / created). To resolve a tag's name and description, use the Tags endpoints.

Response Codes

CodeMeaning
200 OKThe person was found; the IdentityPersonItem is returned.
404 Not FoundNo person exists with that personId.
401 UnauthorizedMissing or invalid JWT.
403 ForbiddenThe user lacks the Read All Identity permission.