Get subscriber list by customer ID
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 either the VSR or CustomerAdministrator role to run the API.

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

			getSubscriberByCustomer&

			customer=<id>
None
 

URL parameters


Provide the following parameter.

Table 2. Parameters

Parameter
Required
Description
id
Yes
The internal ID of the customer. To obtain the ID, use one of the GET methods that are defined in the Get customer list by email address or organization name topic.
 

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

Sample HTTP response

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 Get a list of all subscribers for a customer with a given ID.
The API caller must have the VSR role to run the API.
Name Type Optional Description
_namedQuery
enumerated No possible values are getSubscriberByEmailAddress or getSubscriberByCustomer
Authorized values:
  • getSubscriberByCustomer
customer
string No The internal ID of the customer. User when _namedQuery parameter is getSubscriberByCustomer
Output
Content Type: application/json