CPE Activity Summary API

The Continuing Pharmacy Education (CPE) Activity Summary API allows access to an individual’s CPE activity details. The data returned from this API can be found below.

Parties requesting an API key will need to contact our technology department and follow the setup guidelines provided.

The CPE Activity Summary API provides CPE information for an individual profile using the provided parameters.

MethodAPI
POST /v2/cpe/activity

Parameters

NameValueDescription
eProfileIdIntegere-Profile of Individual
DOBString(Mandatory) Person’s date of birth; (Format: MM-DD)
ActivityDateFromString(Mandatory) CPE activity from date (Format: MM-DD-YYYY)
ActivityDateToString(Mandatory) CPE activity to date (Format: MM-DD-YYYY)

Returned Data

A list of CPE Activity summary data will be returned consisting of the following fields described here.

NameValueDescription
Activity dateStringCPE Activity Date
UANStringUniversal Activity Number
TitleStringTitle
ProviderStringCE Provider
FormatStringValue: Home Study or Live
Topic DesignatorStringTopic Designators
Credit unitsStringUnit Type
LiveStringNo. of Live Units
HomeStringNo. of Home Study Units
ActivityTypeStringActivity Type

Responses

Status CodeDescription
200Successful response
400Invalid request/Please retry
401Unauthorized
403Forbidden
404No CPE data available
409Provided DOB is not a match/e-Profile not found
500Error while processing request

Example:
{
CPEActivity : [
ActivityDate :string,
“ UAN” :string,
“ Title” :string,
“ Provider” :string,
“ Format ”:string,
“ TopicDesignator”:string,
“ CreditUnits” :string,
“ Live”:string,
“ Home” :string,
“ ActivityType” :string
]
}

Looking for additional assistance?

Contact the Member Relations and Government Affairs team for API requests or incidents.

API Interest Form