Attendance Sheet

Export attendance sheets as CSV or PDF files

GET

https://api.getcommunal.com/api

/attendance_sheets/export

Export attendance sheets as CSV or PDF files › query Parameters

sheet_ids[]

integer[] · required

format

string · enum

Enum values:

csv

pdf

Export attendance sheets as CSV or PDF files › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

Export attendance sheets as CSV or PDF files › Responses

string

List attendance sheets

GET

https://api.getcommunal.com/api

/attendance_sheets

List attendance sheets › query Parameters

filter[registration_opportunity_id]

integer

Filter by registration opportunity ID.

filter[parent_program_id]

integer

Filter by program ID.

filter[date]

string

Filter by date (YYYY-MM-DD).

include

string

Include related resources (comma-separated). Options: registrationOpportunities, records, records.programSignup.

List attendance sheets › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

List attendance sheets › Responses

Paginated set of AttendanceSheetResource

AttendanceSheetResource[] · required

current_page

integer · min: 1 · required

from

integer | null · min: 1 · required

last_page

integer · min: 1 · required

per_page

integer · min: 1 · required

to

integer | null · min: 1 · required

total

integer · min: 0 · required

GET/attendance_sheets

curl https://api.getcommunal.com/api/attendance_sheets \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "registration_opportunity_ids": [
        42,
        43
      ],
      "date": "2025-06-15",
      "coverage": "series",
      "starts_on": "2026-09-05",
      "ends_on": "2026-10-24",
      "session_count": 8,
      "current_session_index": 3,
      "registrant_count": 6,
      "can_update": true,
      "can_add_person": true,
      "recordsCount": 5,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-20T14:45:00.000000Z",
      "parentProgram": "parentProgram",
      "registrationOpportunities": "registrationOpportunities",
      "records": "records",
      "sessions": [
        {
          "id": 12,
          "date": "2026-09-19",
          "index": 3,
          "is_current": true,
          "is_locked": false
        }
      ]
    }
  ],
  "current_page": 1,
  "from": 1,
  "last_page": 1,
  "per_page": 1,
  "to": 1,
  "total": 0
}

json

application/json

Get an attendance sheet

GET

https://api.getcommunal.com/api

/attendance_sheets/{attendance_sheet}

Get an attendance sheet › path Parameters

attendance_sheet

string · required

Get an attendance sheet › query Parameters

include

string

Include related resources (comma-separated). Options: registrationOpportunities, records, records.programSignup.

Get an attendance sheet › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

Get an attendance sheet › Responses

AttendanceSheetResource

AttendanceSheetResource

id

integer · required

registration_opportunity_ids

integer[] · required

Registration opportunity identifiers linked to this attendance sheet.

Example: [42,43]

date

string · required

coverage

string · required

Whether this sheet covers a single date or a date series.

Example: series

starts_on

string | null · required

First session calendar date (YYYY-MM-DD).

Example: 2026-09-05

ends_on

string | null · required

Last session calendar date (YYYY-MM-DD).

Example: 2026-10-24

session_count

integer · required

Number of sessions on this sheet.

Example: 8

current_session_index

integer | null · required

1-based index of the current session, or null when the sheet has no sessions.

Example: 3

registrant_count

integer · required

Distinct registrants on this sheet.

Example: 6

can_update

boolean · required

Whether the current viewer may update or delete this sheet.

Example: true

can_add_person

boolean · required

Whether the current viewer may register a person from this sheet.

Example: true

created_at

string · ISO 8601 (UTC) · required

updated_at

string · ISO 8601 (UTC) · required

parentProgram

string | null · required

Program this attendance sheet belongs to (derived from first registration opportunity).

recordsCount

integer | null

registrationOpportunities

string

Registration opportunities this attendance sheet includes.

records

string

Attendance records for this sheet.

AttendanceSheetSession[]

Sessions this sheet covers, oldest first.

GET/attendance_sheets/{attendance_sheet}

curl https://api.getcommunal.com/api/attendance_sheets/:attendance_sheet \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 1,
  "registration_opportunity_ids": [
    42,
    43
  ],
  "date": "2025-06-15",
  "coverage": "series",
  "starts_on": "2026-09-05",
  "ends_on": "2026-10-24",
  "session_count": 8,
  "current_session_index": 3,
  "registrant_count": 6,
  "can_update": true,
  "can_add_person": true,
  "recordsCount": 5,
  "created_at": "2025-01-15T10:30:00.000000Z",
  "updated_at": "2025-01-20T14:45:00.000000Z",
  "parentProgram": "parentProgram",
  "registrationOpportunities": "registrationOpportunities",
  "records": "records",
  "sessions": [
    {
      "id": 12,
      "date": "2026-09-19",
      "index": 3,
      "is_current": true,
      "is_locked": false
    }
  ]
}

json

application/json

Program Attendance Record

Communal Platform API

Attendance Sheet

Export attendance sheets as CSV or PDF files

GET

https://api.getcommunal.com/api

/attendance_sheets/export

Export attendance sheets as CSV or PDF files › query Parameters

sheet_ids[]

integer[] · required

format

string · enum

Enum values:

csv

pdf

Export attendance sheets as CSV or PDF files › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

Export attendance sheets as CSV or PDF files › Responses

string

List attendance sheets

GET

https://api.getcommunal.com/api

/attendance_sheets

List attendance sheets › query Parameters

filter[registration_opportunity_id]

integer

Filter by registration opportunity ID.

filter[parent_program_id]

integer

Filter by program ID.

filter[date]

string

Filter by date (YYYY-MM-DD).

include

string

Include related resources (comma-separated). Options: registrationOpportunities, records, records.programSignup.

List attendance sheets › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

List attendance sheets › Responses

Paginated set of AttendanceSheetResource

AttendanceSheetResource[] · required

current_page

integer · min: 1 · required

from

integer | null · min: 1 · required

last_page

integer · min: 1 · required

per_page

integer · min: 1 · required

to

integer | null · min: 1 · required

total

integer · min: 0 · required

GET/attendance_sheets

curl https://api.getcommunal.com/api/attendance_sheets \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "registration_opportunity_ids": [
        42,
        43
      ],
      "date": "2025-06-15",
      "coverage": "series",
      "starts_on": "2026-09-05",
      "ends_on": "2026-10-24",
      "session_count": 8,
      "current_session_index": 3,
      "registrant_count": 6,
      "can_update": true,
      "can_add_person": true,
      "recordsCount": 5,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-20T14:45:00.000000Z",
      "parentProgram": "parentProgram",
      "registrationOpportunities": "registrationOpportunities",
      "records": "records",
      "sessions": [
        {
          "id": 12,
          "date": "2026-09-19",
          "index": 3,
          "is_current": true,
          "is_locked": false
        }
      ]
    }
  ],
  "current_page": 1,
  "from": 1,
  "last_page": 1,
  "per_page": 1,
  "to": 1,
  "total": 0
}

json

application/json

Get an attendance sheet

GET

https://api.getcommunal.com/api

/attendance_sheets/{attendance_sheet}

Get an attendance sheet › path Parameters

attendance_sheet

string · required

Get an attendance sheet › query Parameters

include

string

Include related resources (comma-separated). Options: registrationOpportunities, records, records.programSignup.

Get an attendance sheet › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

Get an attendance sheet › Responses

AttendanceSheetResource

AttendanceSheetResource

id

integer · required

registration_opportunity_ids

integer[] · required

Registration opportunity identifiers linked to this attendance sheet.

Example: [42,43]

date

string · required

coverage

string · required

Whether this sheet covers a single date or a date series.

Example: series

starts_on

string | null · required

First session calendar date (YYYY-MM-DD).

Example: 2026-09-05

ends_on

string | null · required

Last session calendar date (YYYY-MM-DD).

Example: 2026-10-24

session_count

integer · required

Number of sessions on this sheet.

Example: 8

current_session_index

integer | null · required

1-based index of the current session, or null when the sheet has no sessions.

Example: 3

registrant_count

integer · required

Distinct registrants on this sheet.

Example: 6

can_update

boolean · required

Whether the current viewer may update or delete this sheet.

Example: true

can_add_person

boolean · required

Whether the current viewer may register a person from this sheet.

Example: true

created_at

string · ISO 8601 (UTC) · required

updated_at

string · ISO 8601 (UTC) · required

parentProgram

string | null · required

Program this attendance sheet belongs to (derived from first registration opportunity).

recordsCount

integer | null

registrationOpportunities

string

Registration opportunities this attendance sheet includes.

records

string

Attendance records for this sheet.

AttendanceSheetSession[]

Sessions this sheet covers, oldest first.

GET/attendance_sheets/{attendance_sheet}

curl https://api.getcommunal.com/api/attendance_sheets/:attendance_sheet \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 1,
  "registration_opportunity_ids": [
    42,
    43
  ],
  "date": "2025-06-15",
  "coverage": "series",
  "starts_on": "2026-09-05",
  "ends_on": "2026-10-24",
  "session_count": 8,
  "current_session_index": 3,
  "registrant_count": 6,
  "can_update": true,
  "can_add_person": true,
  "recordsCount": 5,
  "created_at": "2025-01-15T10:30:00.000000Z",
  "updated_at": "2025-01-20T14:45:00.000000Z",
  "parentProgram": "parentProgram",
  "registrationOpportunities": "registrationOpportunities",
  "records": "records",
  "sessions": [
    {
      "id": 12,
      "date": "2026-09-19",
      "index": 3,
      "is_current": true,
      "is_locked": false
    }
  ]
}

json

application/json

Program Attendance Record