Search People

Find people by tag or by a custom entity-field value. Each result is a full IdentityPersonItem (the same shape returned by Get Identity). To fetch a single known person by id, use Get Identity instead.

API Endpoints

• Base URL (Cloud): https://customername.econnectcloud.com/identities
• Base URL (On-prem): https://<server-host-or-ip>:5009

Method	Endpoint	Description
GET	/api/v1/people?tagId={tagId}	People who have the given tag.
GET	/api/v1/people?entityFieldName={name}&entityFieldStringValue={value}	People whose custom field matches. Omit the value to match any person who has that field set.
GET	/api/v1/people/entityField/{fieldName}/entityValue/{fieldValue}	Path-style equivalent of the field lookup.

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.

Permission	Category
Read All Identity	Identities

Query Parameters

Parameter	Type	Description
tagId	string (GUID)	Return people who have this tag.
entityFieldName	string	Custom field name to match.
entityFieldStringValue	string	Value to match for entityFieldName. If omitted, matches any person who has that field set.

URL-encode field names and values that contain spaces or special characters.

Code Examples

Curl

API_URL="https://customername.econnectcloud.com/identities"
TOKEN="your_jwt"

# Find people who have a given tag
curl -sk -X GET "$API_URL/api/v1/people?tagId=4c5d6e7f-8091-2345-6789-abcdef012345" \
  -H "Authorization: Bearer $TOKEN" | jq

# Find people by a custom entity field (name + value)
curl -sk -X GET "$API_URL/api/v1/people?entityFieldName=LoyaltyTier&entityFieldStringValue=Gold" \
  -H "Authorization: Bearer $TOKEN" | jq

# Same lookup using the path-style variant
curl -sk -X GET "$API_URL/api/v1/people/entityField/LoyaltyTier/entityValue/Gold" \
  -H "Authorization: Bearer $TOKEN" | jq

PowerShell

$API_URL = "https://customername.econnectcloud.com/identities"
$TOKEN   = "your_jwt"
$headers = @{ Authorization = "Bearer $TOKEN" }

# Find people who have a given tag
Invoke-RestMethod -Uri "$API_URL/api/v1/people?tagId=4c5d6e7f-8091-2345-6789-abcdef012345" `
    -Method Get -Headers $headers

# Find people by a custom entity field (name + value)
Invoke-RestMethod -Uri "$API_URL/api/v1/people?entityFieldName=LoyaltyTier&entityFieldStringValue=Gold" `
    -Method Get -Headers $headers

C#

using eConnect.IdentitiesDbSdk;

// NuGet: eConnect.IdentitiesDbSdk (private package - request access from eConnect support).

var httpClient = new HttpClient();

var sdk = await IdentityDbSdk.GetSdk(
    "https://customername.econnectcloud.com/identities",
    httpClient,
    "your_username",
    "your_password");

// Find people who have a given tag
var byTag = await sdk.QueryPeopleAsync(tagId: Guid.Parse("4c5d6e7f-8091-2345-6789-abcdef012345"));

// Find people by a custom entity field (name + value)
var byField = await sdk.QueryPeopleAsync(entityFieldName: "LoyaltyTier", entityFieldStringValue: "Gold");

// Same lookup using the path-style variant
var byField2 = await sdk.GetPersonByEntityFieldAsync("LoyaltyTier", "Gold");

foreach (var person in byField)
    Console.WriteLine($"{person.PersonId}: {person.Aliases.FirstOrDefault()?.FirstName}");

Response

200 OK — an array of IdentityPersonItem objects (aliases, addresses, entity fields, tags, notes). See Get Identity → Response for the per-item shape. An empty array is returned when nothing matches.

Response Codes

Code	Meaning
200 OK	Query ran; returns the matching people (possibly empty).
401 Unauthorized	Missing or invalid JWT.
403 Forbidden	The user lacks the Read All Identity permission.