v1

latestOpenAPI 3.0.02026-07-263403911.5 MB

Csr

Get CSR

Get customer service record from a provider.

get/v1/Provider/csr

csr.profile_idinteger required

Format - int32. Identifier of the provider profile used to lookup a customer service record.

csr.phone_numberstring required

Phone number that will be used for customer service record inquiry.

csr.provider_account_idinteger

Format - int32. Provider account identifier used to further identify how to lookup the customer service record.

csr.provider_recordboolean

Indicates if the customer service record should pull all records of the provider and not just your records (not supported by all providers).

customer_numberstring

Primary number of the customer in the provider's system.

namestring

Name of the customer in the provider's system.

class'Business' | 'Residential'

Class of the customer in the provider's system.

customer_codestring

Secondary customer identifier used in the provider's system.

is_activeboolean

Indicates whether the customer is active in the provider's system.

deny_datestring date-time

The most recent date that the customer's service was denied/suspended in the provider's system.

company_codestring

Primary identifier of the account where the customer is provisioned in the provider's system.

reseller_idstring

Secondary identifier of the account where the customer is provisioned in the provider's system.

sic_codestring

SIC (Standard Industry Classification) code of the customer in the provider's system.

yellow_pagestring

Yellow page heading of the customer in the provider's system.