Skip to main content
GET
Fetch Descriptors (v2)
New integrations should use v2; the legacy endpoint is Fetch Descriptors (v1). For a per-program roll-up (none / pending / enrolled) instead of individual records, see Enrollment Status.

Headers

X-API-Key
string
required

Your API key. Sent in the X-API-Key header.

Query Parameters

program
enum<string>

Filter by program (case-insensitive).

Available options:
ethoca,
cdrn,
rdr,
amex,
discover
status
enum<string>

Filter by descriptor status (case-insensitive). Descriptor lifecycle state. PendingRemoval means an unenroll was requested for a previously Enrolled descriptor; it stays live until provider de-registration is confirmed, then the record is deleted.

Available options:
Pending,
Enrolled,
Disabled,
Surpressed,
Processing,
Rejected,
InReview,
PendingRemoval
page
integer
default:1

The page to request. Default 1.

per
integer
default:10

How many records per page. Default 10, max 1000.

Required range: x <= 1000

Response

OK

descriptors
object[]
required
page
integer
required
per
integer
required
total
integer
required