API
⌘K
My Developer Account

Organization

The organization represents a single church. Every other resource is scoped to this record.

Example Request 

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

View in API Explorer →

Example Object 

{
  "type": "Organization",
  "id": "1",
  "attributes": {
    "name": "string",
    "time_zone": "string"
  },
  "relationships": {}
}

Attributes

Name Type Description
id primary_key
name string

The name of the organization.
time_zone string

The time zone of the organization.

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

Reading

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

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/groups/v2/campuses Campus

campuses for this organization
GET https://api.planningcenteronline.com/groups/v2/events Event

events for all groups in this organization
  • campus

    from specific campuses; provide an additional campus_id param as a comma-separated list of IDs, ex: ?filter=campus&campus_id=1,2,3

  • canceled

    has a canceled_at date and time

  • group

    from specific groups; provide an additional group_id param as a comma-separated list of IDs, ex: ?filter=group&group_id=1,2,3

  • group_type

    from specific group types; provide an additional group_type_id param as a comma-separated list of IDs, ex: ?filter=group_type&group_type_id=1,2,3

  • my_groups

    only group events of which you are a member

  • not_canceled

    does not have a canceled_at date and time

  • upcoming

    future starts_at date and time
GET https://api.planningcenteronline.com/groups/v2/group_applications GroupApplication

requests to join groups for this organization
GET https://api.planningcenteronline.com/groups/v2/group_types GroupType

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
GET https://api.planningcenteronline.com/groups/v2/groups Group

groups for this organization
  • campus

    from specific campuses; provide an additional campus_id param as a comma-separated list of IDs, ex: ?filter=campus&campus_id=1,2,3

  • enrollment

    filter groups with enrollment settings; provide an additional enrollment param as a comma-separated list of values, ex: ?filter=enrollment&enrollment=open_signup,request_to_join,closed

  • group

    from specific groups; provide an additional group_id param as a comma-separated list of IDs, ex: ?filter=group&group_id=1,2,3

  • group_type

    from specific group types; provide an additional group_type_id param as a comma-separated list of IDs, ex: ?filter=group_type&group_type_id=1,2,3

  • hidden

    filter groups that are not published on Church Center

  • meeting_schedule

    filter groups that have a meeting schedule

  • my_groups

    only groups of which you are a member

  • people_database_searchable

    based on their setting of allowing leaders to search the entire church database in Groups; provide an additional people_database_searchable param with only or none, ex: ?filter=people_database_searchable&people_database_searchable=only

  • published

    filter groups that are published on Church Center

  • tag

    filter groups with tags; provide an additional tag_id param as a comma-separated list of IDs, ex: ?filter=tag&tag_id=1,2,3. filtering by tags within a tag group will expand results, and across tag groups will reduce results.
GET https://api.planningcenteronline.com/groups/v2/people Person

people for this organization
GET https://api.planningcenteronline.com/groups/v2/tag_groups TagGroup

tag groups in this organization
  • public

    where display_publicly is enabled