### GET /processes Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves a list of all process workflows configured for the church. ```APIDOC ## GET /processes ### Description Retrieve all process workflows configured for the church. ### Method GET ### Endpoint /processes ### Response #### Success Response (200 OK) - **id** (integer) - The unique identifier for the process workflow. - **name** (string) - The name of the process workflow. - **description** (string) - A description of the process workflow. - **active** (boolean) - Indicates if the process workflow is currently active. - **queue_count** (integer) - The number of queues associated with this process workflow. #### Response Example ```json [ { "id": 30, "name": "New Member Onboarding", "description": "Multi-step process for integrating new members", "active": true, "queue_count": 5 }, { "id": 31, "name": "Volunteer Background Check", "description": "Background check workflow for volunteers", "active": true, "queue_count": 3 } ] ``` ``` -------------------------------- ### Get Form Questions using cURL Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Fetch all questions associated with a particular form, identified by its ID. This operation utilizes GET and requires authentication and version negotiation headers. ```bash curl -X GET https://api.ccbchurch.com/forms/101/questions \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### Get Form Responses using cURL Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieve a list of all responses submitted for a given form. This GET request supports pagination using query parameters like `per_page` and `page`. It requires authentication and version negotiation headers. ```bash curl -X GET "https://api.ccbchurch.com/forms/101/responses?per_page=50&page=1" \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### GET /processes/{process_id}/queues Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves all queues associated with a specific process workflow. ```APIDOC ## GET /processes/{process_id}/queues ### Description Retrieve all queues for a specific process workflow. ### Method GET ### Endpoint /processes/{process_id}/queues ### Parameters #### Path Parameters - **process_id** (integer) - Required - The ID of the process workflow to retrieve queues for. ### Response #### Success Response (200 OK) - **id** (integer) - The unique identifier for the queue. - **process_id** (integer) - The ID of the parent process workflow. - **name** (string) - The name of the queue. - **order** (integer) - The order of this queue within the process workflow. - **individual_count** (integer) - The number of individuals currently in this queue. - **managers** (array) - A list of managers for this queue. - **id** (integer) - The ID of the manager. - **name** (string) - The name of the manager. #### Response Example ```json [ { "id": 300, "process_id": 30, "name": "Initial Contact", "order": 1, "individual_count": 12, "managers": [ { "id": 200, "name": "Pastor Mike" } ] }, { "id": 301, "process_id": 30, "name": "Membership Class", "order": 2, "individual_count": 8, "managers": [ { "id": 200, "name": "Pastor Mike" } ] }, { "id": 302, "process_id": 30, "name": "Small Group Placement", "order": 3, "individual_count": 5, "managers": [ { "id": 220, "name": "Small Groups Director" } ] } ] ``` ``` -------------------------------- ### Get Form Questions Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieve all questions associated with a specific form. ```APIDOC ## GET /forms/{form_id}/questions ### Description Retrieve all questions for a specific form. ### Method GET ### Endpoint `/forms/{form_id}/questions` #### Path Parameters - **form_id** (integer) - Required - The unique identifier of the form. ### Request Example ```bash curl -X GET https://api.ccbchurch.com/forms/101/questions \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` ### Response #### Success Response (200) An array of question objects. - **id** (integer) - The unique identifier of the question. - **question** (string) - The text of the question. - **question_type** (string) - The type of question (e.g., "TEXT", "EMAIL", "SINGLE_CHOICE"). - **required** (boolean) - Whether the question is mandatory. - **order** (integer) - The order in which the question appears. - **choices** (array of strings, optional) - A list of possible choices for multiple-choice questions. #### Response Example ```json [ { "id": 1001, "question": "What is your name?", "question_type": "TEXT", "required": true, "order": 1 }, { "id": 1004, "question": "How did you hear about our church?", "question_type": "SINGLE_CHOICE", "required": true, "order": 4, "choices": [ "Friend/Family", "Google Search", "Social Media", "Drove By", "Other" ] } ] ``` ``` -------------------------------- ### GET /individuals/{individual_id}/metrics/process_queues Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves an individual's progress metrics through various process workflows. ```APIDOC ## GET /individuals/{individual_id}/metrics/process_queues ### Description Retrieve an individual's progress through process workflows. ### Method GET ### Endpoint /individuals/{individual_id}/metrics/process_queues ### Parameters #### Path Parameters - **individual_id** (integer) - Required - The ID of the individual whose process queue metrics are to be retrieved. ### Response #### Success Response (200 OK) - **process_id** (integer) - The ID of the process workflow. - **process_name** (string) - The name of the process workflow. - **current_queue** (object) - Information about the individual's current queue. - **id** (integer) - The ID of the current queue. - **name** (string) - The name of the current queue. - **order** (integer) - The order of the current queue within the process. - **entered_at** (string) - The timestamp when the individual entered the current stage of the process. - **completed_queues** (array) - A list of queues the individual has already completed. - **id** (integer) - The ID of the completed queue. - **name** (string) - The name of the completed queue. - **completed_at** (string) - The timestamp when the individual completed this queue. #### Response Example ```json [ { "process_id": 30, "process_name": "New Member Onboarding", "current_queue": { "id": 301, "name": "Membership Class", "order": 2 }, "entered_at": "2024-11-15T10:00:00Z", "completed_queues": [ { "id": 300, "name": "Initial Contact", "completed_at": "2024-11-22T14:30:00Z" } ] } ] ``` ``` -------------------------------- ### Search Volunteers by Criteria Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Searches for individuals available for scheduling based on category, position, and name. This GET request requires authentication and API versioning headers. ```bash curl -X GET "https://api.ccbchurch.com/scheduling/search_individuals?category_id=20&position_id=204&name=john" \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### Get Form Details Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieve detailed information about a specific form, including its title, description, status, and settings. ```APIDOC ## GET /forms/{form_id} ### Description Retrieve detailed information about a specific form. ### Method GET ### Endpoint `/forms/{form_id}` #### Path Parameters - **form_id** (integer) - Required - The unique identifier of the form. ### Request Example ```bash curl -X GET https://api.ccbchurch.com/forms/101 \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` ### Response #### Success Response (200) - **id** (integer) - The unique identifier of the form. - **title** (string) - The title of the form. - **description** (string) - A description of the form. - **status** (string) - The current status of the form (e.g., "ACTIVE"). - **publicly_listed** (boolean) - Whether the form is publicly listed. - **campus_id** (integer) - The ID of the campus associated with the form. - **campus** (object) - Information about the campus. - **id** (integer) - The campus ID. - **name** (string) - The campus name. - **question_count** (integer) - The number of questions in the form. - **response_count** (integer) - The number of responses submitted for the form. - **allow_multiple_responses** (boolean) - Whether multiple responses are allowed. - **require_login** (boolean) - Whether login is required to submit a response. - **confirmation_message** (string) - The message displayed after a successful submission. - **created** (string) - The date and time the form was created (ISO 8601 format). - **modified** (string) - The date and time the form was last modified (ISO 8601 format). #### Response Example ```json { "id": 101, "title": "Visitor Information", "description": "Help us get to know you better! Please fill out this form so we can connect with you.", "status": "ACTIVE", "publicly_listed": true, "campus_id": 1, "campus": { "id": 1, "name": "Main Campus" }, "question_count": 8, "response_count": 145, "allow_multiple_responses": false, "require_login": false, "confirmation_message": "Thank you for submitting your information! We look forward to connecting with you soon.", "created": "2023-01-10T10:00:00Z", "modified": "2024-09-15T14:30:00Z" } ``` ``` -------------------------------- ### Get Individual Attendance Metrics (Bash) Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves attendance metrics and trends for an individual over a specified period. Requires an API key and specifies the API version. ```bash curl -X GET "https://api.ccbchurch.com/individuals/123/metrics/attendance?start_date=2024-01-01&end_date=2024-12-31" \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### Get Membership Types (Bash) Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves a list of all configured membership types for the church organization. The request includes an Authorization header and specifies the API version. ```bash curl -X GET https://api.ccbchurch.com/church/membership_types \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### List Scheduling Categories Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves all scheduling categories used for volunteer management. This operation is a GET request and requires authentication and API versioning headers. ```bash curl -X GET https://api.ccbchurch.com/scheduling/categories \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### Get Membership Types Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieve a list of all configured membership types for the church. Requires authentication. ```APIDOC ## GET /church/membership_types ### Description Retrieve all configured membership types. ### Method GET ### Endpoint `/church/membership_types` ### Parameters No parameters. ### Request Example ```bash curl -X GET https://api.ccbchurch.com/church/membership_types \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` ### Response #### Success Response (200) - **id** (integer) - The unique identifier of the membership type. - **name** (string) - The name of the membership type (e.g., "Member", "Guest"). #### Response Example ```json [ { "id": 1, "name": "Member" }, { "id": 2, "name": "Regular Attender" } ] ``` ``` -------------------------------- ### Get Church Information (Bash) Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves general information about the church organization. This endpoint requires authentication and specifies the API version. ```bash curl -X GET https://api.ccbchurch.com/church \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### GET /events - List Events Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves a list of events, supporting filtering by campus, date range, and pagination. ```APIDOC ## GET /events ### Description Retrieve events with filtering and pagination. ### Method GET ### Endpoint /events ### Parameters #### Query Parameters - **campus_id** (integer) - Optional - Filter events by campus ID. - **start_date** (string) - Optional - Filter events starting on or after this date (YYYY-MM-DD). - **end_date** (string) - Optional - Filter events ending on or before this date (YYYY-MM-DD). - **per_page** (integer) - Optional - Number of events to return per page (default 50). - **page** (integer) - Optional - Page number for pagination (default 1). ### Request Example ```bash curl -X GET "https://api.ccbchurch.com/events?campus_id=1&start_date=2024-12-01&end_date=2024-12-31&per_page=50&page=1" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` ### Response #### Success Response (200) - **Array of Event Objects**: Each object contains details of an event. #### Response Example ```json [ { "id": 500, "name": "Sunday Service", "description": "Weekly worship service with contemporary music and biblical teaching", "campus_id": 1, "group": { "id": 10, "name": "Main Congregation" }, "start_datetime": "2024-12-08T10:00:00Z", "end_datetime": "2024-12-08T11:30:00Z", "location": "Main Sanctuary", "recurrence": "WEEKLY", "listed": true, "registration_required": false, "attendance_grouping": { "id": 1, "name": "Sunday Worship" } } ] ``` ``` -------------------------------- ### Get Group Members (Bash) Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves all members of a specified group, including their membership details. Requires authentication and specifies the API version. ```bash curl -X GET https://api.ccbchurch.com/groups/789/members \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### Get Campus Service Times (Bash) Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves all service times for a specific campus, identified by its ID. This request includes authentication headers and specifies the API version. ```bash curl -X GET https://api.ccbchurch.com/campuses/1/service_times \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### GET /scheduling/search_individuals Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Search for individuals available for scheduling based on category and position. This endpoint helps identify potential volunteers for specific roles. ```APIDOC ## GET /scheduling/search_individuals ### Description Search for individuals available for scheduling. ### Method GET ### Endpoint /scheduling/search_individuals ### Parameters #### Path Parameters None #### Query Parameters - **category_id** (integer) - Required - The ID of the scheduling category to search within. - **position_id** (integer) - Required - The ID of the volunteer position. - **name** (string) - Optional - Filter by individual's name (can be partial). #### Request Body None ### Request Example ```bash curl -X GET "https://api.ccbchurch.com/scheduling/search_individuals?category_id=20&position_id=204&name=john" \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` ### Response #### Success Response (200) - **individual_id** (integer) - The unique identifier for the individual. - **name** (string) - The full name of the individual. - **email** (string) - The email address of the individual. - **phone** (string) - The phone number of the individual. - **position** (object) - Information about the position the individual is suitable for. - **id** (integer) - The ID of the position. - **name** (string) - The name of the position. - **availability** (string) - The current availability status of the individual (e.g., AVAILABLE). - **last_served** (string) - The date when the individual last served (YYYY-MM-DD). #### Response Example ```json [ { "individual_id": 260, "name": "John Davis", "email": "john.davis@example.com", "phone": "(555) 444-5555", "position": { "id": 204, "name": "Audio Tech" }, "availability": "AVAILABLE", "last_served": "2024-11-24" } ] ``` ``` -------------------------------- ### Execute Saved Search Query Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Runs a previously saved advanced search query using its unique ID. This GET request requires authentication and API versioning headers. ```bash curl -X GET https://api.ccbchurch.com/saved_searches/search/450 \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### Get Group Attendance Summary (Bash) Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves attendance statistics for a specified group within a date range. Requires authentication and specifies the API version. ```bash curl -X GET "https://api.ccbchurch.com/groups/789/attendance?start_date=2024-01-01&end_date=2024-12-31" \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### GET /events/{id} - Get Event Details Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves detailed information for a specific event, with options to include attendance information. ```APIDOC ## GET /events/{id} ### Description Retrieve detailed information about a specific event. ### Method GET ### Endpoint /events/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the event to retrieve. #### Query Parameters - **occurrence** (string) - Optional - Specify a particular occurrence date for recurring events (YYYYMMDD format). - **attendance_info** (boolean) - Optional - Include attendance details if true. ### Request Example ```bash curl -X GET "https://api.ccbchurch.com/events/500?occurrence=20241208&attendance_info=true" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` ### Response #### Success Response (200) - **Event Object**: Detailed information about the specified event. #### Response Example ```json { "id": 500, "name": "Sunday Service", "description": "Weekly worship service with contemporary music and biblical teaching", "campus_id": 1, "campus": { "id": 1, "name": "Main Campus" }, "group": { "id": 10, "name": "Main Congregation" }, "start_datetime": "2024-12-08T10:00:00Z", "end_datetime": "2024-12-08T11:30:00Z", "location": "Main Sanctuary", "attendance_grouping": { "id": 1, "name": "Sunday Worship" }, "recurrence": { "frequency": "WEEKLY", "interval": 1, "days_of_week": ["SUNDAY"] }, "listed": true, "registration_required": false, "attendance": { "expected": 250, "recorded": 235, "attendance_taken": true, "attendance_taken_by": { "id": 300, "name": "Admin User" }, "attendance_taken_at": "2024-12-08T12:00:00Z" }, "created": "2023-01-01T10:00:00Z", "modified": "2024-12-06T08:00:00Z" } ``` ``` -------------------------------- ### List Church Processes Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves a list of all process workflows configured for the church. Requires authentication and returns details for each process, including its ID, name, description, active status, and current queue count. ```bash curl -X GET https://api.ccbchurch.com/processes \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### List Public Groups (Bash) Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves a list of public groups, allowing for filtering by campus, group type, meeting day, and listing status. Pagination is supported using 'per_page' and 'page' query parameters. Authentication and API versioning are required. ```bash curl -X GET "https://api.ccbchurch.com/groups?campus_id=1&group_type_id=5&meet_day_id=4&listed=true&per_page=50&page=1" \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### Create New Family (Bash) Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Creates a new family record, including details such as name, campus, primary contact ID, address, and phone number. Requires an API key and specifies JSON content type. ```bash curl -X POST https://api.ccbchurch.com/families \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" \ -H "Content-Type: application/json" \ -d '{ \ "name": "Johnson Family", \ "campus_id": 1, \ "primary_contact_id": 125, \ "address": { \ "mailing": { \ "street": "456 Oak Avenue", \ "city": "Springfield", \ "state": "IL", \ "zip": "62702" \ } \ }, \ "phone": { \ "home": "(555) 876-5432" \ } \ }' ``` -------------------------------- ### Get Event Details via CCB API Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves detailed information for a specific event using its ID and optionally includes occurrence date and attendance information. This GET request requires authentication and specifies the API version. ```bash curl -X GET "https://api.ccbchurch.com/events/500?occurrence=20241208&attendance_info=true" \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### GET /forms Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieve a list of all forms with filtering options. ```APIDOC ## GET /forms ### Description Retrieve all forms with filtering options. ### Method GET ### Endpoint `/forms` ### Parameters #### Path Parameters None #### Query Parameters - **campus_id** (integer) - Optional - Filter forms by campus ID. - **status** (string) - Optional - Filter forms by status (e.g., ACTIVE, DRAFT, ARCHIVED). - **publicly_listed** (boolean) - Optional - Filter forms by public listing status. - **per_page** (integer) - Optional - Number of results per page (default 25). - **page** (integer) - Optional - The page number for pagination. #### Request Body None ### Request Example ```bash curl -X GET "https://api.ccbchurch.com/forms?campus_id=1&status=ACTIVE&publicly_listed=true&per_page=25&page=1" \ -H "Authorization: Bearer " \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the form. - **title** (string) - The title of the form. - **description** (string) - A description of the form. - **status** (string) - The current status of the form. - **publicly_listed** (boolean) - Whether the form is publicly listed. - **campus_id** (integer) - The ID of the campus associated with the form. - **question_count** (integer) - The number of questions in the form. - **response_count** (integer) - The number of responses received for the form. - **created** (string) - Timestamp when the form was created. - **actions** (object) - Available actions for the current user. - **canRespondToForm** (object) - Indicates if the user can respond to the form. - **allowed** (boolean) - True if allowed, false otherwise. - **canManageForm** (object) - Indicates if the user can manage the form. - **allowed** (boolean) - True if allowed, false otherwise. #### Response Example ```json [ { "id": 101, "title": "Visitor Information", "description": "Help us get to know you better!", "status": "ACTIVE", "publicly_listed": true, "campus_id": 1, "question_count": 8, "response_count": 145, "created": "2023-01-10T10:00:00Z", "actions": { "canRespondToForm": {"allowed": true}, "canManageForm": {"allowed": false} } } ] ``` ``` -------------------------------- ### Get Process Queues Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves all queues associated with a specific process workflow. Requires authentication and the process ID. Returns a list of queues, each with its ID, name, order, individual count, and assigned managers. ```bash curl -X GET https://api.ccbchurch.com/processes/30/queues \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### List Families (Bash) Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Searches and retrieves family records with pagination. Supports filtering by name and specifying the number of results per page. Requires an API key. ```bash curl -X GET "https://api.ccbchurch.com/families?name=Smith&per_page=25&page=1" \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### GET /groups/{group_id} Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves comprehensive information about a specific group. ```APIDOC ## GET /groups/{group_id} ### Description Retrieve comprehensive information about a specific group. ### Method GET ### Endpoint /groups/{group_id} #### Path Parameters - **group_id** (integer) - Required - The unique identifier for the group. ### Request Example ```bash curl -X GET https://api.ccbchurch.com/groups/789 \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` ### Response #### Success Response (200) - **id** (integer) - The group's unique identifier. - **campus_id** (integer) - The ID of the campus the group is associated with. - **campus** (object) - Information about the associated campus. - **name** (string) - The name of the group. - **description** (string) - A description of the group. - **inactive** (boolean) - Indicates if the group is inactive. - **group_type** (object) - Information about the group type. - **department** (object) - Information about the department the group belongs to. - **area** (object) - Information about the area the group belongs to. - **interaction_type** (string) - The type of interaction (e.g., IN_PERSON). - **membership_type** (string) - The type of membership (e.g., OPEN_TO_ALL). - **meeting_location_type** (string) - The type of meeting location. - **member_count** (integer) - The current number of members. - **childcare** (boolean) - Indicates if childcare is provided. - **listed** (boolean) - Indicates if the group is listed publicly. - **public_search_listed** (boolean) - Indicates if the group is visible in public searches. - **full** (boolean) - Indicates if the group is full. - **capacity** (integer) - The maximum capacity of the group. - **main_leader** (object) - Information about the main leader of the group. - **meet_day** (object) - Information about the meeting day. - **meet_time** (object) - Information about the meeting time. - **address** (object) - The meeting address details, including latitude and longitude. - **photo_url** (string) - URL to the group's photo. - **created** (string) - The timestamp when the group was created (ISO 8601 format). - **modified** (string) - The timestamp when the group was last modified (ISO 8601 format). #### Response Example ```json { "id": 789, "campus_id": 1, "campus": { "id": 1, "name": "Main Campus" }, "name": "Young Adults Small Group", "description": "A community for young adults ages 20-35 to grow in faith together. We meet weekly for Bible study, fellowship, and prayer.", "inactive": false, "group_type": { "id": 5, "name": "Small Group" }, "department": { "id": 3, "name": "Young Adults Ministry" }, "area": { "id": 2, "name": "Discipleship" }, "interaction_type": "IN_PERSON", "membership_type": "OPEN_TO_ALL", "meeting_location_type": "ROTATING_HOMES", "member_count": 24, "childcare": true, "listed": true, "public_search_listed": true, "full": false, "capacity": 30, "main_leader": { "id": 200, "name": "Pastor Mike", "email": "mike@church.com", "phone": "(555) 111-2222" }, "meet_day": { "id": 4, "name": "Thursday" }, "meet_time": { "id": 3, "name": "Evening" }, "address": { "street": "789 Elm Street", "city": "Springfield", "state": "IL", "zip": "62703", "latitude": 39.7850, "longitude": -89.6505 }, "photo_url": "https://cdn.ccbchurch.com/photos/groups/789/group.jpg", "created": "2022-08-15T10:00:00Z", "modified": "2024-11-30T16:00:00Z" } ``` ``` -------------------------------- ### List Campuses (Bash) Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves a list of all campuses associated with a church organization. This endpoint requires authentication and specifies the desired API version. ```bash curl -X GET https://api.ccbchurch.com/campuses \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### GET /groups Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves a list of public groups with various filtering options. ```APIDOC ## GET /groups ### Description Retrieve all public groups with filtering options. ### Method GET ### Endpoint /groups #### Query Parameters - **campus_id** (integer) - Optional - Filter by campus ID. - **group_type_id** (integer) - Optional - Filter by group type ID. - **meet_day_id** (integer) - Optional - Filter by meeting day ID. - **listed** (boolean) - Optional - Filter by listed status (true/false). - **per_page** (integer) - Optional - Number of results per page (default: 50). - **page** (integer) - Optional - Page number for pagination (default: 1). ### Request Example ```bash curl -X GET "https://api.ccbchurch.com/groups?campus_id=1&group_type_id=5&meet_day_id=4&listed=true&per_page=50&page=1" \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` ### Response #### Success Response (200) - Returns an array of group objects. Each object contains: - **id** (integer) - The group's unique identifier. - **campus_id** (integer) - The ID of the campus the group is associated with. - **name** (string) - The name of the group. - **description** (string) - A description of the group. - **inactive** (boolean) - Indicates if the group is inactive. - **group_type** (object) - Information about the group type. - **interaction_type** (string) - The type of interaction (e.g., IN_PERSON). - **membership_type** (string) - The type of membership (e.g., OPEN_TO_ALL). - **member_count** (integer) - The current number of members. - **childcare** (boolean) - Indicates if childcare is provided. - **listed** (boolean) - Indicates if the group is listed publicly. - **full** (boolean) - Indicates if the group is full. - **main_leader** (object) - Information about the main leader of the group. - **meet_day** (object) - Information about the meeting day. - **meet_time** (object) - Information about the meeting time. - **address** (object) - The meeting address details. #### Response Example ```json [ { "id": 789, "campus_id": 1, "name": "Young Adults Small Group", "description": "A community for young adults ages 20-35 to grow in faith together", "inactive": false, "group_type": { "id": 5, "name": "Small Group" }, "interaction_type": "IN_PERSON", "membership_type": "OPEN_TO_ALL", "member_count": 24, "childcare": true, "listed": true, "full": false, "main_leader": { "id": 200, "name": "Pastor Mike", "email": "mike@church.com" }, "meet_day": { "id": 4, "name": "Thursday" }, "meet_time": { "id": 3, "name": "Evening" }, "address": { "street": "789 Elm Street", "city": "Springfield", "state": "IL", "zip": "62703" } } ] ``` ``` -------------------------------- ### Get Individual Process Queue Metrics Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves an individual's progress and metrics across all process workflows they are part of. Requires authentication and the individual's ID. Returns details on the process, current queue, entry time, and completed queues with completion times. ```bash curl -X GET https://api.ccbchurch.com/individuals/125/metrics/process_queues \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### Get Individual Form Responses (Bash) Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieves all form responses submitted by a specific individual using their ID. Requires an Authorization header and specifies the API version in the Accept header. ```bash curl -X GET https://api.ccbchurch.com/individuals/125/form_responses \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` -------------------------------- ### Get Church Information Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Retrieve general information about the church organization. Requires authentication. ```APIDOC ## GET /church ### Description Retrieve general information about the church organization. ### Method GET ### Endpoint `/church` ### Parameters No parameters. ### Request Example ```bash curl -X GET https://api.ccbchurch.com/church \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -H "Accept: application/vnd.ccbchurch.v2+json" ``` ### Response #### Success Response (200) - **id** (integer) - The unique identifier of the church. - **name** (string) - The name of the church organization. - **subdomain** (string) - The subdomain used for accessing the church's services. - **address** (object) - The main address of the church. - **street** (string) - Street name and number. - **city** (string) - City name. - **state** (string) - State abbreviation. - **zip** (string) - ZIP code. - **phone** (string) - The main phone number of the church. - **email** (string) - The main email address of the church. - **website** (string) - The official website URL of the church. - **timezone** (string) - The primary timezone of the church (e.g., "America/Chicago"). - **campus_count** (integer) - The total number of campuses associated with the church. - **member_count** (integer) - The total number of members in the church organization. - **active** (boolean) - Indicates if the church organization is active. #### Response Example ```json { "id": 1, "name": "Springfield Community Church", "subdomain": "springfieldcc", "address": { "street": "100 Church Street", "city": "Springfield", "state": "IL", "zip": "62701" }, "phone": "(555) 111-0000", "email": "info@springfieldcc.org", "website": "https://www.springfieldcc.org", "timezone": "America/Chicago", "campus_count": 2, "member_count": 2100, "active": true } ``` ``` -------------------------------- ### Obtain OAuth 2.0 Access Token Source: https://context7.com/itsgibsonb/ccbapi/llms.txt Exchanges an authorization code for an access token using the token endpoint. Requires grant type, subdomain, client ID, client secret, authorization code, and redirect URI. Returns access token, token type, expiration, refresh token, and scopes. ```bash curl -X POST https://api.ccbchurch.com/oauth/token \ -H "Accept: application/vnd.ccbchurch.v2+json" \ -H "Content-Type: application/json" \ -d '{ "grant_type": "authorization_code", "subdomain": "yourchurch", "client_id": "your_client_id_here", "client_secret": "your_client_secret_here", "code": "authorization_code_from_redirect", "redirect_uri": "https://yourapp.com/callback" }' ```