Jump to: navigation, search



  • GET /profiles


HTTP Headers

Key ValueType Value Description Mandatory Unique Default
X-Genesys-TenantId Integer Integer value of tenant id false true
X-Genesys-Segment String Segment value (not to be provided by customer) false true


Key ValueType Value Description Mandatory Unique Default
include_profile String "yes" or "no"
  • "no" (default) to return the list of customers IDs without their profile attributes.
  • "yes" to return all the profile attributes of the identified customers.
false false no
id_key String The key name used for identification.

Information.png UCS can infer the key based on the attributes included in the "expr" parameter. However, explicitly specifying the identification key with your application improves performance.

false false
include_extensions String "always" or "unique"
  • "always" (default) to return the extensions specified with the field "extension" if one or more customers are identified.
  • "unique" to return the extensions identified in parameter "extensions" if a unique customer is identified.
false false always
extensions String A comma separated list of extension names The names of the extension to return with the customer profiles. Your application can specify multiple values separated with comas, such as: extensions=contacts, purchases false false
attributes MapStringList One or more identification keys used to identify the customer, for instance: last_name=Doe&first_name=Jane

Important.png Attribute names with no prefix are supposed to be profile attributes. To refer to the attributes of an extension, your application must use the extension name as a prefix for the attribute: (ext-name).(attribute-name)

true false


GET /profiles/contacts.phone_number=408-888-3214&extensions=contacts,purchases&include_profile=yes



ReturnCode ReturnString Description
200 OK Request successful


FaultCode FaultString Description
400 Bad Request General error which can be one of the following reasons:
  • Missing required parameter.
  • Parameter value of unexpected type.
  • Invalid object syntax.
  • Missing required attribute
401 Not Authorized Credentials are missing or incorrect, or the given user is not allowed to execute a given service (such as an administrative service method that changes the profile schema).
403 Forbidden The operation is forbidden and the reason is specified in the error message. This error is returned in the following cases:
  • Attempt to add customer profiles prior to the definition of a profile schema.
404 Not Found The specified URI is invalid, or the requested resource (such as a customer, service, state, task, extension, or identification key) does not exist.
405 Method Not Allowed Returned when an unsupported operation is requested. For instance, if a resource supports only PUT and GET operations, a POST request on this resource returns this error.
415 Unsupported Media Type In the header of your request, Content-Type is not set to a valid value. Most operations of Context Services support only "application/json".


200 OK
 [{"customer_id": "2DC255C02AF", "name": "Doe, John", "birthdate": "1976-05-10"},
 {"customer_id": "DDF295802AF", "name": "Doe, Jane", "birthdate": "1978-02-25"}]
200 OK
[{ "customer_id": "0004Va58A92T0017 ",
 "name": "Doe, John",
 "birthdate": "1976-05-10",
 "EmailAddress": [
 "contacts": [
  {"phone": "408-555-1234", "ext": "1234"},
  {"phone": "408-832-7712"} ],
 "preferences": { "newsletter": "y", "new_offers": "n", "email": "html" }
This page was last modified on May 18, 2018, at 08:05.


Comment on this article:

blog comments powered by Disqus