API
⌘K
My Developer Account

MessageGroup

A message group represents one or more emails or text messages sent from one of the Planning Center apps. The message group indicates the from person, app, etc.

Example Request 

curl https://api.planningcenteronline.com/people/v2/message_groups

View in API Explorer →

Example Object 

{
  "type": "MessageGroup",
  "id": "1",
  "attributes": {
    "contains_user_generated_content": true,
    "created_at": "2000-01-01T12:00:00Z",
    "from_address": "string",
    "message_count": 1,
    "message_type": "string",
    "reply_to_address": "string",
    "reply_to_name": "string",
    "subject": "string",
    "system_message": true,
    "transactional_message": true,
    "uuid": "string"
  },
  "relationships": {}
}

Attributes

Name Type Description
contains_user_generated_content boolean
created_at date_time
from_address string
id primary_key
message_count integer
message_type string
reply_to_address string
reply_to_name string
subject string
system_message boolean
transactional_message boolean
uuid string

Can Include

Parameter Value Description Assignable
include app

include associated app
include from

include associated from
include messages

include associated messages

Order By

Parameter Value Type Description
order contains_user_generated_content string

prefix with a hyphen (-containsusergenerated_content) to reverse the order
order created_at string

prefix with a hyphen (-created_at) to reverse the order
order from_address string

prefix with a hyphen (-from_address) to reverse the order
order message_count string

prefix with a hyphen (-message_count) to reverse the order
order message_type string

prefix with a hyphen (-message_type) to reverse the order
order reply_to_address string

prefix with a hyphen (-replytoaddress) to reverse the order
order reply_to_name string

prefix with a hyphen (-replytoname) to reverse the order
order subject string

prefix with a hyphen (-subject) to reverse the order
order system_message string

prefix with a hyphen (-system_message) to reverse the order
order transactional_message string

prefix with a hyphen (-transactional_message) to reverse the order
order uuid string

prefix with a hyphen (-uuid) to reverse the order

Query By

Name Parameter Type Description Example
contains_user_generated_content where[contains_user_generated_content] boolean

Query on a specific containsusergenerated_content

 ?where[contains_user_generated_content]=true
created_at where[created_at] date_time

Query on a specific created_at

 ?where[created_at]=2000-01-01T12:00:00Z
from_address where[from_address] string

Query on a specific from_address

 ?where[from_address]=string
message_count where[message_count] integer

Query on a specific message_count

 ?where[message_count]=1
message_type where[message_type] string

Query on a specific message_type

 ?where[message_type]=string
reply_to_address where[reply_to_address] string

Query on a specific replytoaddress

 ?where[reply_to_address]=string
reply_to_name where[reply_to_name] string

Query on a specific replytoname

 ?where[reply_to_name]=string
subject where[subject] string

Query on a specific subject

 ?where[subject]=string
system_message where[system_message] boolean

Query on a specific system_message

 ?where[system_message]=true
transactional_message where[transactional_message] boolean

Query on a specific transactional_message

 ?where[transactional_message]=true
uuid where[uuid] string

Query on a specific uuid

 ?where[uuid]=string

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 /people/v2/message_groups

Reading

HTTP Method Endpoint
GET /people/v2/message_groups/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/message_groups/{message_group_id}/app App
GET https://api.planningcenteronline.com/people/v2/message_groups/{message_group_id}/from Person
GET https://api.planningcenteronline.com/people/v2/message_groups/{message_group_id}/messages Message

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/people/v2/messages/{message_id}/message_group Message
GET https://api.planningcenteronline.com/people/v2/message_groups Organization
GET https://api.planningcenteronline.com/people/v2/people/{person_id}/message_groups Person