Get Customer by IDs

Overview

Use this API to retrieve one or more customers identified by customer IDs. To provide multiple IDs, a comma separated string must be used in request URI. A maximum of 75 IDs is allowed per request. Neither pagination nor range query parameters are supported by this API.

Permissions

Actor Permission
User All of the following are required:
  • 'View Agent Console' action.
  • If "Customer departmentalization" setting is enabled, then each of the requested customers must belong to either the user's home department, or to the department where the user is a foreign user.
Client Application No additional permission is required.
SecurityoAuthUser or oAuthClient
Request
path Parameters
ids
required
string <= 1500 characters

Pass one id or comma separated list of id(s).

Examples:
Providing single ID.
1001
Providing multiple IDs.
1001,1002
query Parameters
$attribute
string

Server can be prompted to return additional attributes of resource representation using $attribute common query parameter.
Available values: all, level, preferredAgent, role, pin, howReferred, created, createdBy, industry, marketSegment, entitlements, custom.<name>

$sort
string

Customers returned in server response are sorted based on the attribute supplied under $sort.
Available values: id, type, customerName, custom.

Examples:
Response is sorted based on 'id' attribute.
$sort=id
Response is sorted based on 'customerName' attribute.
$sort=customerName
$order
string

Common query parameter $order.

Enum: "asc" "desc"
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

OK

400

Bad Request

  • More than 75 IDs are supplied in request URL.
401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

get/customers/{ids}
Request samples
Response samples
application/json
    

  • GET /core/customermgr/v3/customer/1011
    • 

  • This example demonstrates the following:
      

    • Retrieving the summary attributes of a single individual customer.
      • 

    • This example assumes "Customer departmentalization" setting is not enabled. Hence, the response does not contain department of the customer.
      • 

    

    • 



{
  • "customer": [
    ]
}