List Enrollments

get

https://api.derapi.com/enrollments

Returns a paginated list of Enrollments, including Site references and Enrollment status history.

The returned list can be optionally filtered by vendor and Program.

Query Params

pageSize

int32

1 to 100

Defaults to 50

pageToken

string

vendor

string

enum

A vendor to filter for.

programID

string

^prog-[a-z0-9]+$

Program ID to filter by

status

string

enum

Status to filter by; can be provided multiple times to include multiple statuses.

Show Details

pendingvendor	Pending vendor approval
pending	Pending operator acceptance
enrolled	Enrolled
pendingresubmission	Application needs to be resubmitted
rejected	Rejected
unenrolled	Unenrolled

Allowed:

tags

object

Tags to filter for.

hasTag

array of strings

Tag keys to filter for.

HasTag

siteID

string

^site-[a-z0-9]+$

Site ID to filter by

utilityAccountNumber

string

Filter Enrollments by utility account number. Returns Enrollments where
at least one Application has this utility account number.

The search is case-insensitive and ignores non-alphanumeric characters
(dashes, spaces, etc.). For example, "AC-123 456" and "ac123456" are
treated as equivalent.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200OK

422A validation error