My Developer Account

GroupType

A group type is a category of groups. For example, a church might have group types for "Small Groups" and "Classes".

Example Request

curl https://api.planningcenteronline.com/groups/v2/group_types

View in API Explorer →

Example Object

{
  "type": "GroupType",
  "id": "1",
  "attributes": {
    "church_center_closed_and_full_groups_visible": true,
    "church_center_map_visible": true,
    "church_center_visible": true,
    "color": "string",
    "default_group_settings": "string",
    "description": "string",
    "leaders_can_enable_chat": true,
    "name": "string",
    "position": 1,
    "public_church_center_web_url": "string"
  },
  "relationships": {}
}

Attributes

Name Type Description
church_center_closed_and_full_groups_visible boolean

true if closed and full groups are shown by default on the group type's Church Center page. Otherwise false.

church_center_map_visible boolean

true if the map view is visible on the public groups list page. Otherwise false.

church_center_visible boolean

true if the group type contains any published groups. Otherwise false.

color string

Hex color value. Color themes are a visual tool for administrators on the admin side of Groups. Ex: "#4fd2e3"

default_group_settings string

A JSON object of default settings for groups of this type.

description string

A description of the group type

id primary_key
leaders_can_enable_chat boolean

true if group leaders can enable or disable Chat for their groups. Otherwise false.

name string

The name of the group type

position integer

The position of the group type in relation to other group types.

public_church_center_web_url string

The public URL for the group on Church Center.

Order By

Parameter Value Type Description
order name string

prefix with a hyphen (-name) to reverse the order

order position string

prefix with a hyphen (-position) to reverse the order

Query By

Name Parameter Type Description Example
id where[id] primary_key

Query on a specific id

?where[id]=primary_key

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/group_types

Reading

HTTP Method Endpoint
GET /groups/v2/group_types/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/groups/v2/group_types/{group_type_id}/events Event

events of groups with this group type

  • canceled

    has a canceled_at date and time

  • not_canceled

    do not have a canceled_at date and time

  • upcoming

    future starts_at date and time

GET https://api.planningcenteronline.com/groups/v2/group_types/{group_type_id}/groups Group

groups belonging to this group type

GET https://api.planningcenteronline.com/groups/v2/group_types/{group_type_id}/resources Resource

file or link resources shared with all groups in this group type

  • leaders

    only visible to group leaders

Belongs To

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

group type of this group

GET https://api.planningcenteronline.com/groups/v2/group_types Organization

group types for this organization

  • church_center_visible

    contains groups which are published to Church Center

  • not_church_center_visible

    does not contain any groups published to Church Center