Namespace Crews.PlanningCenter.Api.People.V2025_07_02

Classes

Address: Attributes for the Address resource.

AddressClient: Client for interacting with the Address resource.

AddressCollectionResponse: Collection Response model for Address resource.

AddressRelationships: Relationships for the Address resource.

AddressResource: An address represents a physical and/or mailing address for a person.

AddressResponse: Response model for Address resource.

App: Attributes for the App resource.

AppClient: Client for interacting with the App resource.

AppCollectionResponse: Collection Response model for App resource.

AppResource: An app is one of the handful of apps that Planning Center offers that organizations can subscribe to, e.g. Services, Registrations, etc.

AppResponse: Response model for App resource.

BackgroundCheck: Attributes for the BackgroundCheck resource.

BackgroundCheckClient: Client for interacting with the BackgroundCheck resource.

BackgroundCheckCollectionResponse: Collection Response model for BackgroundCheck resource.

BackgroundCheckRelationships: Relationships for the BackgroundCheck resource.

BackgroundCheckResource: Background Checks for a Person

BackgroundCheckResponse: Response model for BackgroundCheck resource.

BirthdayPeopleClient: Client for interacting with the BirthdayPeople resource.

BirthdayPeopleCollectionResponse: Collection Response model for BirthdayPeople resource.

BirthdayPeopleResponse: Response model for BirthdayPeople resource.

Campus: Attributes for the Campus resource.

CampusClient: Client for interacting with the Campus resource.

CampusCollectionResponse: Collection Response model for Campus resource.

CampusRelationships: Relationships for the Campus resource.

CampusResource: A Campus is a location belonging to an Organization

CampusResponse: Response model for Campus resource.

Carrier: Attributes for the Carrier resource.

CarrierClient: Client for interacting with the Carrier resource.

CarrierCollectionResponse: Collection Response model for Carrier resource.

CarrierResource: Planning Center does not provide a description for this resource.

CarrierResponse: Response model for Carrier resource.

Condition: Attributes for the Condition resource.

ConditionClient: Client for interacting with the Condition resource.

ConditionCollectionResponse: Collection Response model for Condition resource.

ConditionRelationships: Relationships for the Condition resource.

ConditionResource: A condition is an individual criterion used by a List Rule.

ConditionResponse: Response model for Condition resource.

ConnectedPerson: Attributes for the ConnectedPerson resource.

ConnectedPersonClient: Client for interacting with the ConnectedPerson resource.

ConnectedPersonCollectionResponse: Collection Response model for ConnectedPerson resource.

ConnectedPersonRelationships: Relationships for the ConnectedPerson resource.

ConnectedPersonResource: A Connected Person is an account from a different organization linked to an account in this organization.

ConnectedPersonResponse: Response model for ConnectedPerson resource.

CustomSender: Attributes for the CustomSender resource.

CustomSenderClient: Client for interacting with the CustomSender resource.

CustomSenderCollectionResponse: Collection Response model for CustomSender resource.

CustomSenderRelationships: Relationships for the CustomSender resource.

CustomSenderResource: A custom sender that can be used when sending emails.

CustomSenderResponse: Response model for CustomSender resource.

Email: Attributes for the Email resource.

EmailClient: Client for interacting with the Email resource.

EmailCollectionResponse: Collection Response model for Email resource.

EmailRelationships: Relationships for the Email resource.

EmailResource: An email represents an email address and location.

EmailResponse: Response model for Email resource.

FieldDatum: Attributes for the FieldDatum resource.

FieldDatumClient: Client for interacting with the FieldDatum resource.

FieldDatumCollectionResponse: Collection Response model for FieldDatum resource.

FieldDatumRelationships: Relationships for the FieldDatum resource.

FieldDatumResource: A field datum is an individual piece of data for a custom field.

FieldDatumResponse: Response model for FieldDatum resource.

FieldDefinition: Attributes for the FieldDefinition resource.

FieldDefinitionClient: Client for interacting with the FieldDefinition resource.

FieldDefinitionCollectionResponse: Collection Response model for FieldDefinition resource.

FieldDefinitionRelationships: Relationships for the FieldDefinition resource.

FieldDefinitionResource: A field definition represents a custom field -- its name, data type, etc.

FieldDefinitionResponse: Response model for FieldDefinition resource.

FieldOption: Attributes for the FieldOption resource.

FieldOptionClient: Client for interacting with the FieldOption resource.

FieldOptionCollectionResponse: Collection Response model for FieldOption resource.

FieldOptionRelationships: Relationships for the FieldOption resource.

FieldOptionResource: A field option represents an individual option for a custom field of type "select" or "checkboxes".

FieldOptionResponse: Response model for FieldOption resource.

Form: Attributes for the Form resource.

FormCategory: Attributes for the FormCategory resource.

FormCategoryClient: Client for interacting with the FormCategory resource.

FormCategoryCollectionResponse: Collection Response model for FormCategory resource.

FormCategoryResource: A Form Category

FormCategoryResponse: Response model for FormCategory resource.

FormClient: Client for interacting with the Form resource.

FormCollectionResponse: Collection Response model for Form resource.

FormField: Attributes for the FormField resource.

FormFieldClient: Client for interacting with the FormField resource.

FormFieldCollectionResponse: Collection Response model for FormField resource.

FormFieldCondition: Attributes for the FormFieldCondition resource.

FormFieldConditionClient: Client for interacting with the FormFieldCondition resource.

FormFieldConditionCollectionResponse: Collection Response model for FormFieldCondition resource.

FormFieldConditionRelationships: Relationships for the FormFieldCondition resource.

FormFieldConditionResource: A rule that conditionally shows a form field based on the answer given to another (trigger) field.

A condition belongs to the form_field it shows, and points at a trigger_form_field whose answer determines whether that field is displayed. A form field can have at most one condition. The trigger is matched in one of two ways:

- trigger_form_field_option — the condition is met when the answer to the trigger field is this option (used for option-based fields such as dropdowns, gender, campus, etc.).
- trigger_form_field_option_value — the condition is met when the answer to the trigger field equals this string (used for boolean custom fields).

When neither is set, the condition is met whenever the trigger field has any answer.

Conditions are created, updated, and destroyed under the form field they belong to (POST/PATCH/DELETE .../fields/{id}/form_field_conditions). The form_field and trigger_form_field must both belong to the same form, and the trigger_form_field_option must belong to the trigger_form_field. Writing requires permission to manage the form.

FormFieldConditionResponse: Response model for FormFieldCondition resource.

FormFieldOption: Attributes for the FormFieldOption resource.

FormFieldOptionClient: Client for interacting with the FormFieldOption resource.

FormFieldOptionCollectionResponse: Collection Response model for FormFieldOption resource.

FormFieldOptionRelationships: Relationships for the FormFieldOption resource.

FormFieldOptionResource: A field option on a custom form field.

FormFieldOptionResponse: Response model for FormFieldOption resource.

FormFieldRelationships: Relationships for the FormField resource.

FormFieldResource: A field in a custom form.

FormFieldResponse: Response model for FormField resource.

FormRelationships: Relationships for the Form resource.

FormResource: A custom form for people to fill out.

FormResponse: Response model for Form resource.

FormSubmission: Attributes for the FormSubmission resource.

FormSubmissionClient: Client for interacting with the FormSubmission resource.

FormSubmissionCollectionResponse: Collection Response model for FormSubmission resource.

FormSubmissionRelationships: Relationships for the FormSubmission resource.

FormSubmissionResource: A form submission represents a single completed entry submitted through a Planning Center form.

### Creating submissions

POST is supported so external integrations can record submissions captured outside of Church Center — for example, paper forms run through OCR. Creating a submission requires the access token to belong to a user who (1) has overall People permissions of Editor or above and (2) can manage the target form (a Manager, or a user with a manage FormShare).

### Identifying the submitter

Provide either person_id (an existing person in your organization) or person_attributes. When person_attributes is supplied, the API matches against existing profiles by first name (or given name or nickname) + last name + email address. If no match is found, a new person is created automatically.

person_attributes accepts first_name, last_name, and emails_attributes (an array with at least one { "location": "...", "address": "..." } hash).

### Form values

Pass each answer as an included resource of type FormSubmissionValue, with form_field_id referencing a field on the form. The shape of value depends on the field's field_type: plain fields take a string, phone and address fields take an object, and file fields take an array of uploaded file references. See the FormSubmissionValue vertex for the full list of shapes and for how to upload files.

``{ "data": { "attributes": { "person_id": "1" } }, "included": [ { "type": "FormSubmissionValue", "attributes": { "form_field_id": "10", "value": "Blue" } }, { "type": "FormSubmissionValue", "attributes": { "form_field_id": "11", "value": { "number": "555-555-1234", "location": "Mobile" } } }, { "type": "FormSubmissionValue", "attributes": { "form_field_id": "12", "value": { "location": "Home", "street": "123 Main St", "city": "Carlsbad", "state": "CA", "zip": "92008", "country_code": "US" } } }, { "type": "FormSubmissionValue", "attributes": { "form_field_id": "13", "value": [{ "fileID": "us4-2b1f6c0e-5d3a-4f7e-9c21-8a6d0e4b7f10", "fileName": "waiver.pdf" }] } } ] }<code> One important note: if the form field has options (for example, a checkboxes or dropdown field), the submitted </code>value should be the ID of the selected option, not the option's text.

### Side effects

A submission triggers the same side effects as a Church Center submission: notification emails to the form's subscribers, a confirmation email to the submitter (if the form is configured to send one), workflow card creation for workflow answer fields, and profile updates for contact info, birthdate, gender, household, custom fields, and other profile data.

The access token's user is recorded as the submitter, unless they are the person the submission is for. Profile updates from the submission are attributed to that user in the person's history.

When the resolved person is brand new (created by this submission), profile updates happen immediately and the submission is auto-verified. When the resolved person already exists and the form contains verification-required fields, a verification email is sent first; profile updates apply only after the submitter clicks the verification link — matching the behavior of an unauthenticated Church Center submission.

FormSubmissionResponse: Response model for FormSubmission resource.

FormSubmissionValue: Attributes for the FormSubmissionValue resource.

FormSubmissionValueClient: Client for interacting with the FormSubmissionValue resource.

FormSubmissionValueCollectionResponse: Collection Response model for FormSubmissionValue resource.

FormSubmissionValueRelationships: Relationships for the FormSubmissionValue resource.

FormSubmissionValueResource: A single answer to a single field within a form submission.

When creating a FormSubmission, supply one FormSubmissionValue per answered field as a JSON:API included resource. Each must reference a form_field_id belonging to the parent form; values referencing fields on other forms are silently discarded. Blank values are also discarded.

value is write-only. It is accepted when creating a submission but is never returned when reading one. Read answers back through display_value and, for file fields, attachments.

### Uploading files

File answers reference files that have already been uploaded to the Planning Center upload service. Upload each file first with a multipart POST to https://upload.planningcenteronline.com/v2/files, one file per request. The request authenticates like any other Planning Center API request: a personal access token as HTTP Basic, or an OAuth access token as a Bearer token. It does not have to be the same credential that later creates the submission.

<code> curl -X POST https://upload.planningcenteronline.com/v2/files -u <application id>:<secret> -F "file=@waiver.pdf" </code>`<code> The response lists the uploaded file under </code>data<code>. Use </code>data[0].id<code> as </code>fileID<code> and </code>data[0].attributes.name<code> as </code>fileName<code>. </code>fileID<code> must be sent exactly as returned, including its datacenter prefix (such as </code>us4-<code>). Uploads are temporary. </code>data[0].attributes.expires_at<code> is 60 minutes after the upload, so create the submission soon after uploading. People copies the file into its own storage when the submission is created, and that copy is unaffected by the upload expiring. A file answer that is malformed, lacks the prefix, or points at an expired or unknown upload fails the request with a </code>422<code> validation error on </code>value<code> that says which. </code>`<code> { "data": { "attributes": { "person_id": "1" } }, "included": [ { "type": "FormSubmissionValue", "attributes": { "form_field_id": "42", "value": [{ "fileID": "us4-2b1f6c0e-5d3a-4f7e-9c21-8a6d0e4b7f10", "fileName": "waiver.pdf" }] } } ] } </code>

FormSubmissionValueResponse: Response model for FormSubmissionValue resource.

Grade: Attributes for the Grade resource.

GradeClient: Client for interacting with the Grade resource.

GradeCollectionResponse: Collection Response model for Grade resource.

GradeResource: Planning Center does not provide a description for this resource.

GradeResponse: Response model for Grade resource.

Household: Attributes for the Household resource.

HouseholdClient: Client for interacting with the Household resource.

HouseholdCollectionResponse: Collection Response model for Household resource.

HouseholdMembership: Attributes for the HouseholdMembership resource.

HouseholdMembershipClient: Client for interacting with the HouseholdMembership resource.

HouseholdMembershipCollectionResponse: Collection Response model for HouseholdMembership resource.

HouseholdMembershipRelationships: Relationships for the HouseholdMembership resource.

HouseholdMembershipResource: A household membership is the linking record between a household and a person.

HouseholdMembershipResponse: Response model for HouseholdMembership resource.

HouseholdRelationships: Relationships for the Household resource.

HouseholdResource: A household links people together and can have a primary contact. To add a person to an existing household, use the HouseholdMemberships endpoint.

HouseholdResponse: Response model for Household resource.

InactiveReason: Attributes for the InactiveReason resource.

InactiveReasonClient: Client for interacting with the InactiveReason resource.

InactiveReasonCollectionResponse: Collection Response model for InactiveReason resource.

InactiveReasonResource: An inactive reason is a small bit of text indicating why a member is no longer active.

InactiveReasonResponse: Response model for InactiveReason resource.

List: Attributes for the List resource.

ListCategory: Attributes for the ListCategory resource.

ListCategoryClient: Client for interacting with the ListCategory resource.

ListCategoryCollectionResponse: Collection Response model for ListCategory resource.

ListCategoryRelationships: Relationships for the ListCategory resource.

ListCategoryResource: A List Category

ListCategoryResponse: Response model for ListCategory resource.

ListClient: Client for interacting with the List resource.

ListCollectionResponse: Collection Response model for List resource.

ListResource: A list is a powerful tool for finding and grouping people together using any criteria imaginable.

ListResponse: Response model for List resource.

ListResult: Attributes for the ListResult resource.

ListResultClient: Client for interacting with the ListResult resource.

ListResultCollectionResponse: Collection Response model for ListResult resource.

ListResultRelationships: Relationships for the ListResult resource.

ListResultResource: A list result

ListResultResponse: Response model for ListResult resource.

ListShare: Attributes for the ListShare resource.

ListShareClient: Client for interacting with the ListShare resource.

ListShareCollectionResponse: Collection Response model for ListShare resource.

ListShareRelationships: Relationships for the ListShare resource.

ListShareResource: A list share indicates who has access to edit a list.

ListShareResponse: Response model for ListShare resource.

ListStar: Attributes for the ListStar resource.

ListStarClient: Client for interacting with the ListStar resource.

ListStarCollectionResponse: Collection Response model for ListStar resource.

ListStarResource: A starred list for a person indicates it is special in some way

ListStarResponse: Response model for ListStar resource.

MailchimpSyncStatus: Attributes for the MailchimpSyncStatus resource.

MailchimpSyncStatusClient: Client for interacting with the MailchimpSyncStatus resource.

MailchimpSyncStatusCollectionResponse: Collection Response model for MailchimpSyncStatus resource.

MailchimpSyncStatusResource: The status of syncing a List with Mailchimp.

MailchimpSyncStatusResponse: Response model for MailchimpSyncStatus resource.

MaritalStatus: Attributes for the MaritalStatus resource.

MaritalStatusClient: Client for interacting with the MaritalStatus resource.

MaritalStatusCollectionResponse: Collection Response model for MaritalStatus resource.

MaritalStatusResource: A martial status represents a member's current status, e.g. married, single, etc.

MaritalStatusResponse: Response model for MaritalStatus resource.

MembershipType: Attributes for the MembershipType resource.

MembershipTypeClient: Client for interacting with the MembershipType resource.

MembershipTypeCollectionResponse: Collection Response model for MembershipType resource.

MembershipTypeResource: A profile's membership type, e.g. Visitor, Regular Attender, Member, etc.

MembershipTypeResponse: Response model for MembershipType resource.

Message: Attributes for the Message resource.

MessageClient: Client for interacting with the Message resource.

MessageCollectionResponse: Collection Response model for Message resource.

MessageGroup: Attributes for the MessageGroup resource.

MessageGroupClient: Client for interacting with the MessageGroup resource.

MessageGroupCollectionResponse: Collection Response model for MessageGroup resource.

MessageGroupResource: 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.

MessageGroupResponse: Response model for MessageGroup resource.

MessageRelationships: Relationships for the Message resource.

MessageResource: A message is an individual email or sms text sent to a member. Every message has a parent message group.

MessageResponse: Response model for Message resource.

NamePrefix: Attributes for the NamePrefix resource.

NamePrefixClient: Client for interacting with the NamePrefix resource.

NamePrefixCollectionResponse: Collection Response model for NamePrefix resource.

NamePrefixResource: A name prefix is one of Mr., Mrs., etc.

NamePrefixResponse: Response model for NamePrefix resource.

NameSuffix: Attributes for the NameSuffix resource.

NameSuffixClient: Client for interacting with the NameSuffix resource.

NameSuffixCollectionResponse: Collection Response model for NameSuffix resource.

NameSuffixResource: A name suffix is one of Sr., Jr., etc.

NameSuffixResponse: Response model for NameSuffix resource.

Note: Attributes for the Note resource.

NoteCategory: Attributes for the NoteCategory resource.

NoteCategoryClient: Client for interacting with the NoteCategory resource.

NoteCategoryCollectionResponse: Collection Response model for NoteCategory resource.

NoteCategoryRelationships: Relationships for the NoteCategory resource.

NoteCategoryResource: A Note Category

NoteCategoryResponse: Response model for NoteCategory resource.

NoteCategoryShare: Attributes for the NoteCategoryShare resource.

NoteCategoryShareClient: Client for interacting with the NoteCategoryShare resource.

NoteCategoryShareCollectionResponse: Collection Response model for NoteCategoryShare resource.

NoteCategoryShareRelationships: Relationships for the NoteCategoryShare resource.

NoteCategoryShareResource: A note category share defines who can view notes in a category.

NoteCategoryShareResponse: Response model for NoteCategoryShare resource.

NoteCategorySubscription: Attributes for the NoteCategorySubscription resource.

NoteCategorySubscriptionClient: Client for interacting with the NoteCategorySubscription resource.

NoteCategorySubscriptionCollectionResponse: Collection Response model for NoteCategorySubscription resource.

NoteCategorySubscriptionRelationships: Relationships for the NoteCategorySubscription resource.

NoteCategorySubscriptionResource: A subscription for note categories

NoteCategorySubscriptionResponse: Response model for NoteCategorySubscription resource.

NoteClient: Client for interacting with the Note resource.

NoteCollectionResponse: Collection Response model for Note resource.

NoteRelationships: Relationships for the Note resource.

NoteResource: A note is text with a category connected to a person’s profile.

NoteResponse: Response model for Note resource.

Organization: Attributes for the Organization resource.

OrganizationClient: Client for interacting with the Organization resource.

OrganizationCollectionResponse: Collection Response model for Organization resource.

OrganizationResource: The organization represents a single church. Every other resource is scoped to this record.

OrganizationResponse: Response model for Organization resource.

OrganizationStatisticsClient: Client for interacting with the OrganizationStatistics resource.

OrganizationStatisticsCollectionResponse: Collection Response model for OrganizationStatistics resource.

OrganizationStatisticsResponse: Response model for OrganizationStatistics resource.

PaginatedAddressClient: Client for interacting with Address collection resources.

PaginatedAppClient: Client for interacting with App collection resources.

PaginatedBackgroundCheckClient: Client for interacting with BackgroundCheck collection resources.

PaginatedBirthdayPeopleClient: Client for interacting with BirthdayPeople collection resources.

PaginatedCampusClient: Client for interacting with Campus collection resources.

PaginatedCarrierClient: Client for interacting with Carrier collection resources.

PaginatedConditionClient: Client for interacting with Condition collection resources.

PaginatedConnectedPersonClient: Client for interacting with ConnectedPerson collection resources.

PaginatedCustomSenderClient: Client for interacting with CustomSender collection resources.

PaginatedEmailClient: Client for interacting with Email collection resources.

PaginatedFieldDatumClient: Client for interacting with FieldDatum collection resources.

PaginatedFieldDefinitionClient: Client for interacting with FieldDefinition collection resources.

PaginatedFieldOptionClient: Client for interacting with FieldOption collection resources.

PaginatedFormCategoryClient: Client for interacting with FormCategory collection resources.

PaginatedFormClient: Client for interacting with Form collection resources.

PaginatedFormFieldClient: Client for interacting with FormField collection resources.

PaginatedFormFieldConditionClient: Client for interacting with FormFieldCondition collection resources.

PaginatedFormFieldOptionClient: Client for interacting with FormFieldOption collection resources.

PaginatedFormSubmissionClient: Client for interacting with FormSubmission collection resources.

PaginatedFormSubmissionValueClient: Client for interacting with FormSubmissionValue collection resources.

PaginatedGradeClient: Client for interacting with Grade collection resources.

PaginatedHouseholdClient: Client for interacting with Household collection resources.

PaginatedHouseholdMembershipClient: Client for interacting with HouseholdMembership collection resources.

PaginatedInactiveReasonClient: Client for interacting with InactiveReason collection resources.

PaginatedListCategoryClient: Client for interacting with ListCategory collection resources.

PaginatedListClient: Client for interacting with List collection resources.

PaginatedListResultClient: Client for interacting with ListResult collection resources.

PaginatedListShareClient: Client for interacting with ListShare collection resources.

PaginatedListStarClient: Client for interacting with ListStar collection resources.

PaginatedMailchimpSyncStatusClient: Client for interacting with MailchimpSyncStatus collection resources.

PaginatedMaritalStatusClient: Client for interacting with MaritalStatus collection resources.

PaginatedMembershipTypeClient: Client for interacting with MembershipType collection resources.

PaginatedMessageClient: Client for interacting with Message collection resources.

PaginatedMessageGroupClient: Client for interacting with MessageGroup collection resources.

PaginatedNamePrefixClient: Client for interacting with NamePrefix collection resources.

PaginatedNameSuffixClient: Client for interacting with NameSuffix collection resources.

PaginatedNoteCategoryClient: Client for interacting with NoteCategory collection resources.

PaginatedNoteCategoryShareClient: Client for interacting with NoteCategoryShare collection resources.

PaginatedNoteCategorySubscriptionClient: Client for interacting with NoteCategorySubscription collection resources.

PaginatedNoteClient: Client for interacting with Note collection resources.

PaginatedOrganizationClient: Client for interacting with Organization collection resources.

PaginatedOrganizationStatisticsClient: Client for interacting with OrganizationStatistics collection resources.

PaginatedPeopleImportClient: Client for interacting with PeopleImport collection resources.

PaginatedPeopleImportConflictClient: Client for interacting with PeopleImportConflict collection resources.

PaginatedPeopleImportHistoryClient: Client for interacting with PeopleImportHistory collection resources.

PaginatedPersonAppClient: Client for interacting with PersonApp collection resources.

PaginatedPersonClient: Client for interacting with Person collection resources.

PaginatedPersonMergerClient: Client for interacting with PersonMerger collection resources.

PaginatedPhoneNumberClient: Client for interacting with PhoneNumber collection resources.

PaginatedPlatformNotificationClient: Client for interacting with PlatformNotification collection resources.

PaginatedReportClient: Client for interacting with Report collection resources.

PaginatedRuleClient: Client for interacting with Rule collection resources.

PaginatedSchoolOptionClient: Client for interacting with SchoolOption collection resources.

PaginatedServiceTimeClient: Client for interacting with ServiceTime collection resources.

PaginatedSocialProfileClient: Client for interacting with SocialProfile collection resources.

PaginatedSpamEmailAddressClient: Client for interacting with SpamEmailAddress collection resources.

PaginatedTabClient: Client for interacting with Tab collection resources.

PaginatedWorkflowAssigneeSummaryClient: Client for interacting with WorkflowAssigneeSummary collection resources.

PaginatedWorkflowAssigneeWorkflowSummaryClient: Client for interacting with WorkflowAssigneeWorkflowSummary collection resources.

PaginatedWorkflowCardActivityClient: Client for interacting with WorkflowCardActivity collection resources.

PaginatedWorkflowCardClient: Client for interacting with WorkflowCard collection resources.

PaginatedWorkflowCardNoteClient: Client for interacting with WorkflowCardNote collection resources.

PaginatedWorkflowCategoryClient: Client for interacting with WorkflowCategory collection resources.

PaginatedWorkflowClient: Client for interacting with Workflow collection resources.

PaginatedWorkflowShareClient: Client for interacting with WorkflowShare collection resources.

PaginatedWorkflowStepAssigneeSummaryClient: Client for interacting with WorkflowStepAssigneeSummary collection resources.

PaginatedWorkflowStepClient: Client for interacting with WorkflowStep collection resources.

PeopleImport: Attributes for the PeopleImport resource.

PeopleImportClient: Client for interacting with the PeopleImport resource.

PeopleImportCollectionResponse: Collection Response model for PeopleImport resource.

PeopleImportConflict: Attributes for the PeopleImportConflict resource.

PeopleImportConflictClient: Client for interacting with the PeopleImportConflict resource.

PeopleImportConflictCollectionResponse: Collection Response model for PeopleImportConflict resource.

PeopleImportConflictResource: A PeopleImportConflict is a record of change that will occur if the parent PeopleImport is completed.

PeopleImportConflictResponse: Response model for PeopleImportConflict resource.

PeopleImportHistory: Attributes for the PeopleImportHistory resource.

PeopleImportHistoryClient: Client for interacting with the PeopleImportHistory resource.

PeopleImportHistoryCollectionResponse: Collection Response model for PeopleImportHistory resource.

PeopleImportHistoryResource: A PeopleImportHistory is a record of change that occurred when the parent PeopleImport was completed.

PeopleImportHistoryResponse: Response model for PeopleImportHistory resource.

PeopleImportRelationships: Relationships for the PeopleImport resource.

PeopleImportResource: A PeopleImport is a record of an ongoing or previous import from a CSV file.

PeopleImportResponse: Response model for PeopleImport resource.

Person: Attributes for the Person resource.

PersonApp: Attributes for the PersonApp resource.

PersonAppClient: Client for interacting with the PersonApp resource.

PersonAppCollectionResponse: Collection Response model for PersonApp resource.

PersonAppRelationships: Relationships for the PersonApp resource.

PersonAppResource: A Person App is the relationship between a Person and an App.

PersonAppResponse: Response model for PersonApp resource.

PersonClient: Client for interacting with the Person resource.

PersonCollectionResponse: Collection Response model for Person resource.

PersonMerger: Attributes for the PersonMerger resource.

PersonMergerClient: Client for interacting with the PersonMerger resource.

PersonMergerCollectionResponse: Collection Response model for PersonMerger resource.

PersonMergerRelationships: Relationships for the PersonMerger resource.

PersonMergerResource: A Person Merger is the history of profiles that were merged into other profiles.

PersonMergerResponse: Response model for PersonMerger resource.

PersonRelationships: Relationships for the Person resource.

PersonResource: A person record represents a single member/user of the application. Each person has different permissions that determine how the user can use this app (if at all).

PersonResponse: Response model for Person resource.

PhoneNumber: Attributes for the PhoneNumber resource.

PhoneNumberClient: Client for interacting with the PhoneNumber resource.

PhoneNumberCollectionResponse: Collection Response model for PhoneNumber resource.

PhoneNumberRelationships: Relationships for the PhoneNumber resource.

PhoneNumberResource: A phone number represents a single telephone number and location.

PhoneNumberResponse: Response model for PhoneNumber resource.

PlatformNotification: Attributes for the PlatformNotification resource.

PlatformNotificationClient: Client for interacting with the PlatformNotification resource.

PlatformNotificationCollectionResponse: Collection Response model for PlatformNotification resource.

PlatformNotificationResource: A Platform Notification is a suite-wide notification that shows at the top of each application's screen until dismissed by the user.

PlatformNotificationResponse: Response model for PlatformNotification resource.

Report: Attributes for the Report resource.

ReportClient: Client for interacting with the Report resource.

ReportCollectionResponse: Collection Response model for Report resource.

ReportResource: A report is editable liquid syntax that provides a powerful tool for presenting your Lists however you want.

ReportResponse: Response model for Report resource.

Rule: Attributes for the Rule resource.

RuleClient: Client for interacting with the Rule resource.

RuleCollectionResponse: Collection Response model for Rule resource.

RuleResource: A rule belongs to a List and groups conditions together.

RuleResponse: Response model for Rule resource.

SchoolOption: Attributes for the SchoolOption resource.

SchoolOptionClient: Client for interacting with the SchoolOption resource.

SchoolOptionCollectionResponse: Collection Response model for SchoolOption resource.

SchoolOptionResource: A school option represents a school name, school type, grades, etc. and can be selected for a person.

SchoolOptionResponse: Response model for SchoolOption resource.

ServiceTime: Attributes for the ServiceTime resource.

ServiceTimeClient: Client for interacting with the ServiceTime resource.

ServiceTimeCollectionResponse: Collection Response model for ServiceTime resource.

ServiceTimeRelationships: Relationships for the ServiceTime resource.

ServiceTimeResource: A ServiceTime Resource

ServiceTimeResponse: Response model for ServiceTime resource.

SocialProfile: Attributes for the SocialProfile resource.

SocialProfileClient: Client for interacting with the SocialProfile resource.

SocialProfileCollectionResponse: Collection Response model for SocialProfile resource.

SocialProfileResource: A social profile represents a members's Twitter, Facebook, or other social media account.

SocialProfileResponse: Response model for SocialProfile resource.

SpamEmailAddress: Attributes for the SpamEmailAddress resource.

SpamEmailAddressClient: Client for interacting with the SpamEmailAddress resource.

SpamEmailAddressCollectionResponse: Collection Response model for SpamEmailAddress resource.

SpamEmailAddressResource: An email address that is marked as spam

SpamEmailAddressResponse: Response model for SpamEmailAddress resource.

Tab: Attributes for the Tab resource.

TabClient: Client for interacting with the Tab resource.

TabCollectionResponse: Collection Response model for Tab resource.

TabResource: A tab is a custom tab and groups like field definitions.

TabResponse: Response model for Tab resource.

Workflow: Attributes for the Workflow resource.

WorkflowAssigneeSummary: Attributes for the WorkflowAssigneeSummary resource.

WorkflowAssigneeSummaryClient: Client for interacting with the WorkflowAssigneeSummary resource.

WorkflowAssigneeSummaryCollectionResponse: Collection Response model for WorkflowAssigneeSummary resource.

WorkflowAssigneeSummaryRelationships: Relationships for the WorkflowAssigneeSummary resource.

WorkflowAssigneeSummaryResource: Aggregated card counts for an assignee across all visible workflows

WorkflowAssigneeSummaryResponse: Response model for WorkflowAssigneeSummary resource.

WorkflowAssigneeWorkflowSummary: Attributes for the WorkflowAssigneeWorkflowSummary resource.

WorkflowAssigneeWorkflowSummaryClient: Client for interacting with the WorkflowAssigneeWorkflowSummary resource.

WorkflowAssigneeWorkflowSummaryCollectionResponse: Collection Response model for WorkflowAssigneeWorkflowSummary resource.

WorkflowAssigneeWorkflowSummaryRelationships: Relationships for the WorkflowAssigneeWorkflowSummary resource.

WorkflowAssigneeWorkflowSummaryResource: Per-workflow card counts for a specific assignee

WorkflowAssigneeWorkflowSummaryResponse: Response model for WorkflowAssigneeWorkflowSummary resource.

WorkflowCard: Attributes for the WorkflowCard resource.

WorkflowCardActivity: Attributes for the WorkflowCardActivity resource.

WorkflowCardActivityClient: Client for interacting with the WorkflowCardActivity resource.

WorkflowCardActivityCollectionResponse: Collection Response model for WorkflowCardActivity resource.

WorkflowCardActivityRelationships: Relationships for the WorkflowCardActivity resource.

WorkflowCardActivityResource: Workflow Card Activity is a record of an action performed on a card

WorkflowCardActivityResponse: Response model for WorkflowCardActivity resource.

WorkflowCardClient: Client for interacting with the WorkflowCard resource.

WorkflowCardCollectionResponse: Collection Response model for WorkflowCard resource.

WorkflowCardNote: Attributes for the WorkflowCardNote resource.

WorkflowCardNoteClient: Client for interacting with the WorkflowCardNote resource.

WorkflowCardNoteCollectionResponse: Collection Response model for WorkflowCardNote resource.

WorkflowCardNoteResource: Workflow Note is a note that has been made on a Workflow Card

WorkflowCardNoteResponse: Response model for WorkflowCardNote resource.

WorkflowCardRelationships: Relationships for the WorkflowCard resource.

WorkflowCardResource: A Card

WorkflowCardResponse: Response model for WorkflowCard resource.

WorkflowCategory: Attributes for the WorkflowCategory resource.

WorkflowCategoryClient: Client for interacting with the WorkflowCategory resource.

WorkflowCategoryCollectionResponse: Collection Response model for WorkflowCategory resource.

WorkflowCategoryResource: A Workflow Category

WorkflowCategoryResponse: Response model for WorkflowCategory resource.

WorkflowClient: Client for interacting with the Workflow resource.

WorkflowCollectionResponse: Collection Response model for Workflow resource.

WorkflowRelationships: Relationships for the Workflow resource.

WorkflowResource: A Workflow

WorkflowResponse: Response model for Workflow resource.

WorkflowShare: Attributes for the WorkflowShare resource.

WorkflowShareClient: Client for interacting with the WorkflowShare resource.

WorkflowShareCollectionResponse: Collection Response model for WorkflowShare resource.

WorkflowShareRelationships: Relationships for the WorkflowShare resource.

WorkflowShareResource: A workflow share defines who can access a workflow.

WorkflowShareResponse: Response model for WorkflowShare resource.

WorkflowStep: Attributes for the WorkflowStep resource.

WorkflowStepAssigneeSummary: Attributes for the WorkflowStepAssigneeSummary resource.

WorkflowStepAssigneeSummaryClient: Client for interacting with the WorkflowStepAssigneeSummary resource.

WorkflowStepAssigneeSummaryCollectionResponse: Collection Response model for WorkflowStepAssigneeSummary resource.

WorkflowStepAssigneeSummaryRelationships: Relationships for the WorkflowStepAssigneeSummary resource.

WorkflowStepAssigneeSummaryResource: The ready and snoozed count for an assignee & step

WorkflowStepAssigneeSummaryResponse: Response model for WorkflowStepAssigneeSummary resource.

WorkflowStepClient: Client for interacting with the WorkflowStep resource.

WorkflowStepCollectionResponse: Collection Response model for WorkflowStep resource.

WorkflowStepRelationships: Relationships for the WorkflowStep resource.

WorkflowStepResource: A Step

WorkflowStepResponse: Response model for WorkflowStep resource.

Table of Contents

Namespace Crews.PlanningCenter.Api.People.V2025_07_02

Classes