Skip to content

Organization (Services)

The root level of an organization where account-level settings are applied.

The root level of an organization where account-level settings are applied.

Property Value
Product Services (pco.services, API version 2018-11-01)
Resource type Organization
TypeScript Services.Organization, attributes Services.OrganizationAttributes, schema Services.OrganizationSchema
Planning Center path /services/v2
Planning Center docs Organization

How to reach it

Client path Returns Filters Create
pco.services.get() The product root No
pco.services.plans Collection No

From a collection, .id(organizationId) addresses one Organization: pco.services.plans.id(organizationId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Services.OrganizationAttributes. Every resource also has id and type ('Organization') next to its attributes.

Name Type Description
allow_mp3_download boolean | null
beta boolean | null
calendar_starts_on_sunday boolean | null
ccli string | null
ccli_auto_reporting_enabled boolean | null
ccli_connected boolean | null
ccli_reporting_enabled boolean | null
created_at string | null
date_format number | null Two possible values, US EU
extra_file_storage_allowed boolean | null
file_storage_exceeded boolean | null
file_storage_extra_charges number | null
file_storage_extra_enabled boolean | null
file_storage_size boolean | null
file_storage_size_used boolean | null
legacy_id string | null
music_stand_enabled boolean | null
name string | null
owner_name string | null
people_allowed number | null
people_remaining number | null
projector_enabled boolean | null
rehearsal_mix_enabled boolean | null
rehearsal_pack_connected boolean | null
required_to_set_download_permission string | null Possible values: editor, administrator, site_administrator
secret string | null
time_zone string | null
twenty_four_hour_time boolean | null
updated_at string | null

Querying

No documented where fields.

No documented order fields.

Edges

The product root’s edges are the root collections on pco.services.

Writing

Property Value
Create No
Update No
Delete No

Example

import type { Services } from '@mackenly/planningcenterkit';

const { data } = await pco.services.get(); // GET /services/v2
const root: Services.Organization = data;

Type to search…

↑↓ navigate↵ selectEsc close