API
⌘K
My Developer Account

Folder

A folder is a container used to organize multiple Service Types or other Folders.

Example Request

curl https://api.planningcenteronline.com/services/v2/folders

View in API Explorer →

Example Object

{
  "type": "Folder",
  "id": "1",
  "attributes": {
    "container": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "name": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "ancestors": {
      "data": {
        "type": "Folder",
        "id": "1"
      }
    },
    "parent": {
      "data": {
        "type": "Folder",
        "id": "1"
      }
    },
    "campus": {
      "data": {
        "type": "Campus",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
container string
created_at date_time
id primary_key
name string
updated_at date_time

Relationships

Name Type Association Type Note
ancestors Folder to_one
parent Folder to_one
campus Campus to_one

Can Include

Parameter Value Description Assignable
include service_types include associated service_types

Order By

Parameter Value Type Description
order name string prefix with a hyphen (-name) to reverse the order

Query By

Name Parameter Type Description Example
parent_id where[parent_id] integer Query on a related parent ?where[parent_id]=1

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 /services/v2/folders

Reading

HTTP Method Endpoint
GET /services/v2/folders/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /services/v2/folders
  • name
  • parent_id
  • campus_id

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /services/v2/folders/{id}
  • name
  • parent_id
  • campus_id

Deleting

HTTP Method Endpoint
DELETE /services/v2/folders/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/services/v2/folders/{folder_id}/folders Folder
GET https://api.planningcenteronline.com/services/v2/folders/{folder_id}/service_types ServiceType

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/services/v2/folders/{folder_id}/folders Folder
GET https://api.planningcenteronline.com/services/v2/folders Organization
GET https://api.planningcenteronline.com/services/v2/tag_groups/{tag_group_id}/folder TagGroup