API docs by Redocly

Karpura API (7.1.0)

Download OpenAPI specification:

License: Proprietary

Official Karpura API specification. Visit main website: Karpura Admin Portal.

  • API Key Required: All authenticated endpoints require a valid API key, which can be generated in the .
  • Role Inheritance: Newly generated API keys automatically inherit the creating user's roles.
  • Restricting Access: To scope down or limit an API key's permissions, create the key while logged in as a user account with limited roles.

Get API Info

Returns name, version, and deployment mode of the API.

Responses

Response samples

Content type
application/json
{
  • "info": {
    }
}

Get Minimal Organization Details

Returns bare minimum organization details associated with the authenticated API Key. Use this API to get your organization ID, which is required for all other org-specific API calls.

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "orgs_minimal": [
    ],
  • "pagination": {
    }
}

Get Users

Returns a paginated list of users belonging to a specific organization.

Authorizations:
BearerAuth
path Parameters
org_id
required
integer

Unique Organization identifier

query Parameters
page_index
integer
Default: 0

Zero-based page index for pagination

page_size
integer
Example: page_size=25

Number of records to return per page.

sort_column
string
Default: "created_at"
Example: sort_column=created_at

Column field to sort results by.

sort_order
string
Default: "desc"
Enum: "asc" "desc"
Example: sort_order=desc

Sort order direction.

include_subscription
boolean
Default: true
Example: include_subscription=true

Filter to include user subscription state.

Responses

Response samples

Content type
application/json
{
  • "org_users": [
    ],
  • "pagination": {
    }
}

Get Donation Types

Returns a paginated list of donation types a.k.a fundraising campaigns configured for an organization.

Authorizations:
BearerAuth
path Parameters
org_id
required
integer

Unique Organization identifier

query Parameters
include_future
boolean
Default: false
Example: include_future=true

Filter to include Donation Types / Fundraising campaigns that are scheduled to open in the future.

include_past
boolean
Default: false

Filter to include past (expired or outdated) records

include_canceled
boolean
Default: false

Filter to include canceled records

page_index
integer
Default: 0

Zero-based page index for pagination

page_size
integer
Example: page_size=25

Number of records to return per page.

sort_column
string
Default: "created_at"
Example: sort_column=created_at

Column field to sort results by.

sort_order
string
Default: "desc"
Enum: "asc" "desc"
Example: sort_order=desc

Sort order direction.

Responses

Response samples

Content type
application/json
{
  • "donation_types": [
    ],
  • "pagination": {
    }
}

Get Donations

Returns a paginated list of recorded donor contributions and recurring donations for an organization.

Refer to Donation Types for details on associated fundraising campaigns and preset tiers.

Authorizations:
BearerAuth
path Parameters
org_id
required
integer

Unique Organization identifier

query Parameters
include_canceled
boolean
Default: false

Filter to include canceled records

page_index
integer
Default: 0

Zero-based page index for pagination

page_size
integer
Example: page_size=25

Number of records to return per page.

sort_column
string
Default: "created_at"
Example: sort_column=created_at

Column field to sort results by.

sort_order
string
Default: "desc"
Enum: "asc" "desc"
Example: sort_order=desc

Sort order direction.

Responses

Response samples

Content type
application/json
{
  • "donations": [
    ],
  • "pagination": {
    }
}

Get Event Types

Returns Event Types along with their scheduled slots and ticket categories for a specific organization.

Authorizations:
BearerAuth
path Parameters
org_id
required
integer

Unique Organization identifier

query Parameters
include_future
boolean
Default: false
Example: include_future=true

Filter to include Events and Slots whose booking opens in the future.

include_past
boolean
Default: false

Filter to include past (expired or outdated) records

include_canceled
boolean
Default: false

Filter to include canceled records

include_tags
boolean
Default: false
Example: include_tags=true

Include Event Category IDs associated with Events.

page_index
integer
Default: 0

Zero-based page index for pagination

page_size
integer
Example: page_size=25

Number of records to return per page.

Responses

Response samples

Content type
application/json
{
  • "event_types": [
    ],
  • "pagination": {
    }
}

Create Event Type

Creates a new Event Type along with event slots, and ticket structures for an organization.

Authorizations:
BearerAuth
path Parameters
org_id
required
integer

Unique Organization identifier

Request Body schema: application/json
required
name
required
string (EventName) <= 120 characters

Event Name

description
required
string (EventDescription) <= 500 characters

A short description of the Event

additional_details
string or null (EventAdditionalDetails)

Additional details formatted using Karpura Multimedia Format (supports rich text, structured layouts, and embedded images via the Karpura Admin Portal).

Critical: This property cannot be created or modified via the API. Edits must be made in the Admin Portal. When issuing a PATCH request to update an Event Type, you must include this property exactly as received from the prior GET call to prevent it from being cleared.
timezone_name
required
string (TimezoneName)

The official IANA time zone identifier for the location where the Event takes place.

Full list of valid IANA time zone identifiers
location
required
string (EventLocation) <= 240 characters

Event Venue or Location Name or Address

required
Array of objects (EventSlotsCreate) non-empty

Event Time slots and ticket configurations

sequence
integer or null (DisplaySequence)

Display sequence number used to sort the items.

tag_ids
Array of integers or null (EventCategoryIDs)

List of Event Category IDs associated with Events

Responses

Request samples

Content type
application/json
{
  • "name": "Annual Banquet",
  • "description": "Join our Annual Gala and Dinner...",
  • "additional_details": "{\"version\":1,\"bg_color\":\"00000000\",\"rows\":[]}",
  • "timezone_name": "America/New_York",
  • "location": "Symphony Hall",
  • "slots": [
    ],
  • "sequence": null,
  • "tag_ids": null
}

Response samples

Content type
application/json
{
  • "event_types": [
    ],
  • "job_status": {
    }
}

Update Event Type

Updates an existing Event Type.

Critical Update Behavior:
Unlike standard partial PATCH operations, this endpoint performs a full resource replacement:
  • Full Object Required: You must provide the complete object payload containing all fields, including those you do not intend to change.
  • Default Resets: Any omitted fields will automatically reset to their default values.
  • Cascading Deletions: Any Slot or Ticket left out of the array payload will be permanently deleted from the Event Type.
Authorizations:
BearerAuth
path Parameters
org_id
required
integer

Unique Organization identifier

id
required
integer

Unique Event Type identifier

Request Body schema: application/json
required
name
required
string (EventName) <= 120 characters

Event Name

description
required
string (EventDescription) <= 500 characters

A short description of the Event

additional_details
string or null (EventAdditionalDetails)

Additional details formatted using Karpura Multimedia Format (supports rich text, structured layouts, and embedded images via the Karpura Admin Portal).

Critical: This property cannot be created or modified via the API. Edits must be made in the Admin Portal. When issuing a PATCH request to update an Event Type, you must include this property exactly as received from the prior GET call to prevent it from being cleared.
timezone_name
required
string (TimezoneName)

The official IANA time zone identifier for the location where the Event takes place.

Full list of valid IANA time zone identifiers
location
required
string (EventLocation) <= 240 characters

Event Venue or Location Name or Address

required
Array of objects (EventSlotsUpdate) non-empty

Event Time slots and ticket configurations

sequence
integer or null
Default: null

Display sequence number used to sort the items.

tag_ids
Array of integers or null
Default: null

List of Event Category IDs associated with Events

Responses

Request samples

Content type
application/json
{
  • "name": "Annual Banquet",
  • "description": "Join our Annual Gala and Dinner...",
  • "additional_details": "{\"version\":1,\"bg_color\":\"00000000\",\"rows\":[]}",
  • "timezone_name": "America/New_York",
  • "location": "Symphony Hall",
  • "slots": [
    ],
  • "sequence": 10,
  • "tag_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "event_types": [
    ],
  • "job_status": {
    }
}

Delete Event Type

Deletes an Event Type.

Authorizations:
BearerAuth
path Parameters
org_id
required
integer

Unique Organization identifier

id
required
integer

Unique Event Type identifier

Responses

Response samples

Content type
application/json
{
  • "job_status": {
    }
}

Get Event Registrations

Returns a paginated list of event ticket registrations, financial breakdowns, and custom field data for an organization.

Authorizations:
BearerAuth
path Parameters
org_id
required
integer

Unique Organization identifier

query Parameters
include_past
boolean
Default: false

Filter to include past (expired or outdated) records

include_future
boolean
Default: false
Example: include_future=true

Filter to include Events and Slots whose booking opens in the future.

include_canceled
boolean
Default: false

Filter to include canceled records

include_declined
boolean
Default: false

Filter to include Events Registrations declined by users

include_count
boolean
Default: true
Example: include_count=true

Filter to include aggregate record counts in the pagination payload.

include_summary
boolean
Default: true
Example: include_summary=true

Filter to include financial and summaries in field aggregations.

page_index
integer
Default: 0

Zero-based page index for pagination

page_size
integer
Example: page_size=25

Number of records to return per page.

sort_column
string
Default: "created_at"
Example: sort_column=created_at

Column field to sort results by.

sort_order
string
Default: "desc"
Enum: "asc" "desc"
Example: sort_order=desc

Sort order direction.

Responses

Response samples

Content type
application/json
{
  • "event_registrations": [
    ],
  • "pagination": {
    }
}

Get Membership Types

Returns a paginated list of membership types configured for a specific organization.

Authorizations:
BearerAuth
path Parameters
org_id
required
integer

Unique Organization identifier

query Parameters
include_canceled
boolean
Default: false

Filter to include canceled records

page_index
integer
Default: 0

Zero-based page index for pagination

page_size
integer
Example: page_size=25

Number of records to return per page.

sort_column
string
Default: "created_at"
Example: sort_column=created_at

Column field to sort results by.

sort_order
string
Default: "desc"
Enum: "asc" "desc"
Example: sort_order=desc

Sort order direction.

Responses

Response samples

Content type
application/json
{
  • "membership_types": [
    ],
  • "pagination": {
    }
}

Get Member Registrations.

Returns a paginated list of historical member registrations for a specific organization.

Refer to Members for the list of currently active members.

Authorizations:
BearerAuth
path Parameters
org_id
required
integer

Unique Organization identifier

query Parameters
include_past
boolean
Default: false

Filter to include past (expired or outdated) records

include_canceled
boolean
Default: false

Filter to include canceled records

page_index
integer
Default: 0

Zero-based page index for pagination

page_size
integer
Example: page_size=25

Number of records to return per page.

sort_column
string
Default: "created_at"
Example: sort_column=created_at

Column field to sort results by.

sort_order
string
Default: "desc"
Enum: "asc" "desc"
Example: sort_order=desc

Sort order direction.

Responses

Response samples

Content type
application/json
{
  • "memberships": [
    ],
  • "pagination": {
    }
}

Get Active Members

Returns a paginated list of currently active members along with their profile details for a specific organization.

Refer to Member Registrations for the historical records of member registrations.

Authorizations:
BearerAuth
path Parameters
org_id
required
integer

Unique Organization identifier

query Parameters
page_index
integer
Default: 0

Zero-based page index for pagination

page_size
integer
Example: page_size=25

Number of records to return per page.

sort_column
string
Default: "created_at"
Example: sort_column=created_at

Column field to sort results by.

sort_order
string
Default: "desc"
Enum: "asc" "desc"
Example: sort_order=desc

Sort order direction.

Responses

Response samples

Content type
application/json
{
  • "members": [
    ],
  • "pagination": {
    }
}

Get Volunteers

Returns a paginated list of registered volunteers along with contact availability, address, and profile details for an organization.

Refer to Volunteer Programs for details on associated programs.

Authorizations:
BearerAuth
path Parameters
org_id
required
integer

Unique Organization identifier

query Parameters
pid
integer
Example: pid=22

Filter volunteers by Volunteer Program ID.

page_index
integer
Default: 0

Zero-based page index for pagination

page_size
integer
Example: page_size=25

Number of records to return per page.

sort_column
string
Default: "created_at"
Example: sort_column=created_at

Column field to sort results by.

sort_order
string
Default: "desc"
Enum: "asc" "desc"
Example: sort_order=desc

Sort order direction.

Responses

Response samples

Content type
application/json
{
  • "volunteers": [
    ],
  • "pagination": {
    }
}

Get Volunteer Programs

Returns a paginated list of volunteer programs configured for an organization.

Authorizations:
BearerAuth
path Parameters
org_id
required
integer

Unique Organization identifier

query Parameters
inactive
boolean
Default: false

Filter to include or exclude inactive volunteer programs.

canceled
boolean
Default: false

Filter to include or exclude canceled volunteer programs.

page_index
integer
Default: 0

Zero-based page index for pagination

page_size
integer
Example: page_size=25

Number of records to return per page.

sort_column
string
Default: "created_at"
Example: sort_column=created_at

Column field to sort results by.

sort_order
string
Default: "desc"
Enum: "asc" "desc"
Example: sort_order=desc

Sort order direction.

Responses

Response samples

Content type
application/json
{
  • "programs": [
    ],
  • "pagination": {
    }
}