Attachment - Calendar API - Planning Center

Example Request

curl https://api.planningcenteronline.com/calendar/v2/attachments

View in API Explorer →

Example Object

{
  "type": "Attachment",
  "id": "1",
  "attributes": {
    "content_type": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "file_size": 1,
    "name": "string",
    "updated_at": "2000-01-01T12:00:00Z",
    "url": "string"
  },
  "relationships": {
    "event": {
      "data": {
        "type": "Event",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`content_type`	`string`	MIME type of the attachment
`created_at`	`date_time`	UTC time at which the attachment was created
`description`	`string`	Description of the attachment
`file_size`	`integer`	File size in bytes
`id`	`primary_key`	Unique identifier for the attachment
`name`	`string`	Set to the file name if not provided
`updated_at`	`date_time`	UTC time at which the attachment was updated
`url`	`string`	Path to where the attachment is stored

Relationships

Name	Type	Association Type	Note
event	Event	to_one

Can Include

Parameter	Value	Description	Assignable
include	event	include associated event	create and update

Order By

Parameter	Value	Type	Description
order	content_type	string	prefix with a hyphen (-content_type) to reverse the order
order	created_at	string	prefix with a hyphen (-created_at) to reverse the order
order	description	string	prefix with a hyphen (-description) to reverse the order
order	file_size	string	prefix with a hyphen (-file_size) to reverse the order
order	name	string	prefix with a hyphen (-name) to reverse the order
order	updated_at	string	prefix with a hyphen (-updated_at) to reverse the order

Query By

Name	Parameter	Type	Description	Example
content_type	`where[content_type]`	string	Query on a specific content_type	`?where[content_type]=string`
created_at	`where[created_at]`	date_time	Query on a specific created_at	`?where[created_at]=2000-01-01T12:00:00Z`
description	`where[description]`	string	Query on a specific description	`?where[description]=string`
file_size	`where[file_size]`	integer	Query on a specific file_size	`?where[file_size]=1`
name	`where[name]`	string	Query on a specific name	`?where[name]=string`
updated_at	`where[updated_at]`	date_time	Query on a specific updated_at	`?where[updated_at]=2000-01-01T12:00:00Z`

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	`/calendar/v2/attachments`

Reading

HTTP Method	Endpoint
GET	`/calendar/v2/attachments/{id}`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/attachments/{attachment_id}/event`	Event

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/attachments`	Event
GET	`https://api.planningcenteronline.com/calendar/v2/attachments`	Organization