AttachmentType

Create an Attachment Type for each type of file you might want only specific people to see. When you attach a file, you can specify an attachment type to then be able to link the file to a position.

Example Request

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

View in API Explorer →

Example Object

{
  "type": "AttachmentType",
  "id": "1",
  "attributes": {
    "aliases": "string",
    "built_in": true,
    "capoed_chord_charts": true,
    "chord_charts": true,
    "exclusions": "string",
    "lyrics": true,
    "name": "string",
    "number_charts": true,
    "numeral_charts": true
  },
  "relationships": {
    "attachment_type_group": {
      "data": {
        "type": "AttachmentTypeGroup",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`aliases`	`string`
`built_in`	`boolean`
`capoed_chord_charts`	`boolean`
`chord_charts`	`boolean`
`exclusions`	`string`
`id`	`primary_key`
`lyrics`	`boolean`
`name`	`string`
`number_charts`	`boolean`
`numeral_charts`	`boolean`

Relationships

Name	Type	Association Type	Note
attachment_type_group	AttachmentTypeGroup	to_one

Order By

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

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/attachment_types`

Reading

HTTP Method	Endpoint
GET	`/services/v2/attachment_types/{id}`

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/attachment_types`	Organization