Get Profile By Id or Identity

A POST to the /profiles/search-id allows your application to search for a profile by identity handle/identifier, or simply by profile_id

Searching by ID or Identity

AttributeDescription
type
STRING
specify profile_id to search by profile id
specify any other value to search by identity handle
id
STRING
if type is profile_id then this should be the id of the Omneo profile to search.
If type is any other value, this should be the identifier of the handle specified as a type

Searching by identity

Omneo identity handles and identifiers are unique, and never return more than one profile.
When the type is anything other than profile_id then Omneo will attempt to search for a profile with an identities[].handle matching the type and an identities[].identifier matching the id

for example, to search for an Omneo profile with an existing identity handle of "shopify_id" and an identifier of "ID123"
The payload would look like the below

{
  "type": "shopify_id",
  "id" : "ID123"
}

Omneo will attempt to look for a profile in Omneo, which has an existing identity matching:

{
  "handle" : "shopify_id",
  "identifier" : "ID123"
}
Language
Authorization
Header
URL