ItemAssignment - Services API

Example Request

curl https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plans/{plan_id}/items/{item_id}/item_assignments

View in API Explorer →

Example Object

{
  "type": "ItemAssignment",
  "id": "1",
  "attributes": {
    "assignable_type": "string"
  },
  "relationships": {
    "plan": {
      "data": {
        "type": "Plan",
        "id": "1"
      }
    },
    "item": {
      "data": {
        "type": "Item",
        "id": "1"
      }
    },
    "assignable": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`assignable_type`	`string`	Possible values: `Person` or `TeamPosition`.
`id`	`primary_key`

Relationships

Name	Type	Association Type	Note
plan	Plan	to_one
item	Item	to_one
assignable	Person	to_one	Can be a Person or TeamPosition.

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/service_types/{service_type_id}/plans/{plan_id}/items/{item_id}/item_assignments`

Reading

HTTP Method	Endpoint
GET	`/services/v2/service_types/{service_type_id}/plans/{plan_id}/items/{item_id}/item_assignments/{id}`

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plans/{plan_id}/items/{item_id}/item_assignments`	Item