List enrollments for the group

Returns a page of enrollments for the specified group or generated csv roster if rosterType parameter specified.

Request
path Parameters
groupId
required
string <uuid>

The unique identifier of the group to get enrollments for.

query Parameters
payerPlanId
string <uuid>

If set, the items will be filtered on enrollments with the specified payer plan.

networkStatus
string

If set, the items will be filtered on enrollments with the specified network status.

Enum: "None" "Par" "NonPar"
enrollmentStatus
string

If set, the items will be filtered on enrollments with the specified enrollment status.

Enum: "NotSubmitted" "Submitted" "Enrolled" "Denied"
specialistType
string

If set, the items will be filtered on enrollments with the specified specialist type.

Enum: "None" "Pcp" "Specialist"
submissionDate
string <date-time>
effectiveDate
string <date-time>
sortedBy
string
Enum: "Id" "NetworkStatus" "EnrollmentStatus" "SpecialistType" "SubmissionDate" "EffectiveDate" "PayerPlanName"
object

If set, the properties and directions the returned data will be sorted by.

offset
integer <int32>
Deprecated

The offset for the page to start.

cursor
string

The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically.

count
integer <int32>

The number of items to include in a single page.

sortDirection
string

The direction the returned data will be sorted by.

Enum: "Asc" "Desc"
rosterType
string

If set, csv report of specified type will be generated.

Enum: "Providers" "Licenses" "Deas" "LiabilityInsurances"
Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/groups/{groupId}/enrollments
Response samples
application/json
{
  • "sort": {
    },
  • "previousCursor": "string",
  • "nextCursor": "string",
  • "nextOffset": 0,
  • "pageSize": 0,
  • "count": 0,
  • "totalCount": 0,
  • "items": [
    ],
  • "sortedBy": "Id",
  • "sortDirection": "Asc"
}