Get subscriber list by email address
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 15, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

The API caller must have the one of the below role to run the API.
  • VSR
  • CustomerAdministrator

Table 1. API details
Method
Resource address
Operation header
GET
resource/subscriber?_namedQuery=

			getSubscriberByEmailAddress

			&emailAddress=<email>
None
 

URL parameters


Provide the following parameter.

Table 2. Parameters

Parameter
Required
Description
email
Yes
The email address of the subscriber.
 

A list of subscribers that meet the criteria of the query parameters is returned. See the following sample HTTP response:

Sample HTTP response

NOTE: API caller has CustomerAdministrator role this API will return user info of his organization only,If trying to access user of other organization this will return empty list {"List":[]}

For a list of common HTTP status codes that are returned for API calls, see HTTP status codes.

Parent topic: Subscriber management services

Input
Method URI Description
GET /api/bss/resource/subscriber?_namedQuery=getSubscriberByEmailAddress&emailAddress={email} Get a list of subscribers with a given email address.
The API caller must have the VSR role to run the API.
Name Type Optional Description
email
string No The email address of the subscriber.
Output
Content Type: application/json