Blockout - Services API - Planning Center

Example Request

curl https://api.planningcenteronline.com/services/v2/people/{person_id}/blockouts

View in API Explorer →

Example Object

{
  "type": "Blockout",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "ends_at": "2000-01-01T12:00:00Z",
    "group_identifier": "string",
    "organization_name": "string",
    "reason": "string",
    "repeat_frequency": "string",
    "repeat_interval": "string",
    "repeat_period": "string",
    "repeat_until": "2000-01-01",
    "settings": "string",
    "share": true,
    "starts_at": "2000-01-01T12:00:00Z",
    "time_zone": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "organization": {
      "data": {
        "type": "Organization",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`created_at`	`date_time`
`description`	`string`
`ends_at`	`date_time`
`group_identifier`	`string`
`id`	`primary_key`
`organization_name`	`string`
`reason`	`string`
`repeat_frequency`	`string`	Possible values: - no_repeat - every_1 - every_2 - every_3 - every_4 - every_5 - every_6 - every_7 - every_8
`repeat_interval`	`string`	Possible values: - exact_day_of_month - week_of_month_1 - week_of_month_2 - week_of_month_3 - week_of_month_4 - week_of_month_last
`repeat_period`	`string`	Possible values: - daily - weekly - monthly - yearly
`repeat_until`	`date`
`settings`	`string`
`share`	`boolean`
`starts_at`	`date_time`
`time_zone`	`string`
`updated_at`	`date_time`

Relationships

Name	Type	Association Type	Note
person	Person	to_one
organization	Organization	to_one

Query By

Name	Parameter	Type	Description	Example
group_identifier	`where[group_identifier]`	string	Query on a specific group_identifier	`?where[group_identifier]=string`

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/people/{person_id}/blockouts`

Reading

HTTP Method	Endpoint
GET	`/services/v2/people/{person_id}/blockouts/{id}`

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/services/v2/people/{person_id}/blockouts`	reason repeat_frequency repeat_interval repeat_period share repeat_until starts_at ends_at

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/services/v2/people/{person_id}/blockouts/{id}`	reason repeat_frequency repeat_interval repeat_period share repeat_until starts_at ends_at

Deleting

HTTP Method	Endpoint
DELETE	`/services/v2/people/{person_id}/blockouts/{id}`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/people/{person_id}/blockouts/{blockout_id}/blockout_dates`	BlockoutDate
GET	`https://api.planningcenteronline.com/services/v2/people/{person_id}/blockouts/{blockout_id}/blockout_exceptions`	BlockoutException

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/people/{person_id}/blockouts`	Person		`future` `past`