BlockoutDate

The actual dates generated by the blockout or its recurrence pattern. Generated up to a year in advance

Example Request

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

View in API Explorer →

Example Object

{
  "type": "BlockoutDate",
  "id": "1",
  "attributes": {
    "ends_at": "2000-01-01T12:00:00Z",
    "ends_at_utc": "2000-01-01T12:00:00Z",
    "group_identifier": "string",
    "reason": "string",
    "share": true,
    "starts_at": "2000-01-01T12:00:00Z",
    "starts_at_utc": "2000-01-01T12:00:00Z",
    "time_zone": "string"
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "blockout": {
      "data": {
        "type": "Blockout",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`ends_at`	`date_time`	End time as a 'wall-clock' timestamp
`ends_at_utc`	`date_time`
`group_identifier`	`string`
`id`	`primary_key`
`reason`	`string`
`share`	`boolean`
`starts_at`	`date_time`	Start time as a 'wall-clock' timestamp
`starts_at_utc`	`date_time`
`time_zone`	`string`

Relationships

Name	Type	Association Type	Note
person	Person	to_one
blockout	Blockout	to_one

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/{blockout_id}/blockout_dates`

Reading

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

Belongs To

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