Chat - Services API - Planning Center

Example Request

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

View in API Explorer →

Example Object

{
  "type": "Chat",
  "id": "1",
  "attributes": {
    "group_identifiers": [],
    "my_teams": [],
    "payload": "string",
    "people": [],
    "plans": [],
    "teams": [],
    "teams_i_lead": []
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`group_identifiers`	`array`	Only available when requested with the `?fields` param
`id`	`primary_key`
`my_teams`	`array`	Only available when requested with the `?fields` param
`payload`	`string`	Only available when requested with the `?fields` param
`people`	`array`	Only available when requested with the `?fields` param
`plans`	`array`	Only available when requested with the `?fields` param
`teams`	`array`	Only available when requested with the `?fields` param
`teams_i_lead`	`array`	Only available when requested with the `?fields` param

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

Reading

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

Belongs To

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