GroupApplication - Groups API

Example Request

curl https://api.planningcenteronline.com/groups/v2/group_applications

View in API Explorer →

Example Object

{
  "type": "GroupApplication",
  "id": "1",
  "attributes": {
    "applied_at": "2000-01-01T12:00:00Z",
    "message": "string",
    "status": "string"
  },
  "relationships": {
    "group": {
      "data": {
        "type": "Group",
        "id": "1"
      }
    },
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`applied_at`	`date_time`	Timestamp when this person applied.
`id`	`primary_key`
`message`	`string`	An optional personal message from the applicant.
`status`	`string`	The approval status of the application. Possible values: `pending`, `approved`, or `rejected`

Relationships

Name	Type	Association Type	Note
group	Group	to_one
person	Person	to_one

Can Include

Parameter	Value	Description	Assignable
include	group	include associated group	create and update
include	person	include associated person	create and update

Order By

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

Query By

Name	Parameter	Type	Description	Example
applied_at	`where[applied_at]`	date_time	Query on a specific applied_at	`?where[applied_at]=2000-01-01T12:00:00Z`
status	`where[status]`	string	Query on a specific status	`?where[status]=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	`/groups/v2/group_applications`

Reading

HTTP Method	Endpoint
GET	`/groups/v2/group_applications/{id}`

Actions

HTTP Method	Endpoint	Description
POST	`https://api.planningcenteronline.com/groups/v2/group_applications/{group_application_id}/approve`
POST	`https://api.planningcenteronline.com/groups/v2/group_applications/{group_application_id}/reject`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/groups/v2/group_applications/{group_application_id}/group`	Group	group being applied to
GET	`https://api.planningcenteronline.com/groups/v2/group_applications/{group_application_id}/person`	Person	person who applied

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/groups/v2/groups/{group_id}/applications`	Group	requests to join this group
GET	`https://api.planningcenteronline.com/groups/v2/group_applications`	Organization	requests to join groups for this organization