My Developer Account

Enrollment

Details on how and when members can join a Group.

Example Request

curl https://api.planningcenteronline.com/groups/v2/groups/{group_id}/enrollment

View in API Explorer →

Example Object

{
  "type": "Enrollment",
  "id": "1",
  "attributes": {
    "auto_closed": true,
    "auto_closed_reason": "string",
    "closed_message": "string",
    "date_limit": "string",
    "date_limit_reached": true,
    "member_limit": 1,
    "member_limit_alert": 1,
    "member_limit_include_pending": true,
    "member_limit_reached": true,
    "status": "string",
    "strategy": "string"
  },
  "relationships": {
    "group": {
      "data": {
        "type": "Group",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
auto_closed boolean

Whether or not enrollment has been closed automatically due to set limits

auto_closed_reason string

Brief description as to which limit automatically closed enrollment

closed_message string

Custom message displayed on Church Center when enrollment is closed. When blank, a default message is shown.

date_limit string

Date when enrollment should automatically close

date_limit_reached boolean

Whether or not the date_limit has been reached

id primary_key
member_limit integer

Total number of members allowed before enrollment should automatically close

member_limit_alert integer

Number of members that, once exceeded, sends an alert to administrators.

member_limit_include_pending boolean

Whether or not pending membership requests count toward the member_limit.

member_limit_reached boolean

Whether or not the member_limit has been reached

status string

Current enrollment status. Possible values:

  • open - strategy is not closed and no limits have been reached
  • closed - strategy is closed or limits have been reached
  • full - member limit has been reached
  • private - group is unlisted
strategy string

Sign up strategy. Possible values: request_to_join, open_signup, or closed

Relationships

Name Type Association Type Note
group Group to_one

Pagination

Name Parameter Type Description
per_page per_page integer

how many records to return per page (min=1, max=100, default=25)

offset offset integer

get results from given offset

Endpoints

Listing

HTTP Method Endpoint
GET /groups/v2/groups/{group_id}/enrollment

Reading

HTTP Method Endpoint
GET /groups/v2/groups/{group_id}/enrollment/{id}

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/groups/v2/groups/{group_id}/enrollment Group

enrollment details for this group