/api/v1/eventGroups (HTTP GET)

Retrieves a list of event groups.

Request Parameters

ParameterRequiredDefaultDescription
int
page
No0The page number of event groups to be returned.
int
pageSize
No50The number of event groups to be returned per page. This value cannot exceed the default.

Response Type

Array of EventGroup

/api/v1/events (HTTP GET)

Retrieves a list of events.

ParameterRequiredDefaultDescription
EventsGetQuery
query
Yesn/aThe type of query to use when searching events.
ulong
earliestVersion
Dependsn/aRequired when query == EventsGetQuery.Version. Limits the response to events where Event::Version > earliestVersion.
DateTime
earliestTime
Dependsn/aRequired when query == EventsGetQuery.Time. Limits the response to events where Event::EndTime >= earliestTime.

Example:
Assume earliestTime == 2020-01-05.
An event starting 2020-01-03 and ending 2020-01-07 would be returned.
An event starting 2020-01-06 and ending 2020-01-07 would be returned.
An event starting 2020-01-01 and ending 2020-01-03 would not be returned.
DateTime
latestTime
Non/aDetermines the latest starting time of the events to be returned. If specified, limits the response to events where Event::StartTime < latestTime.
int
page
No0The page number of the events to be returned.
int
pageSize
No50The number of events to be returned per page. This value cannot exceed the default.

Response Type

Array of Event

/api/v1/events/ (HTTP GET)

Retrieves an event given its unique id.

Request Parameters

ParameterRequiredDescription
Guid
uid
YesThe unique id of the event to return.

Response Type

Event

/api/v1/organization (HTTP GET)

Retrieves the organization.

Request Parameters

None

Response Type

Organization

/api/v1/userGroups (HTTP GET)

Retrieves a list of user groups. 

Request Parameters

ParameterRequiredDefaultDescription
int
page
No0The page number of user groups to be returned.
int
pageSize
No50The number of user groups to be returned per page. This value cannot exceed the default.

Response Type

Array of UserGroup

/api/v2/users (HTTP GET)

Retrieves a list of users.

Request Parameters

ParameterRequiredDefaultDescription
UsersGetQuery
query
Yesn/aDetermines the method to use when searching users (e.g., the order in which they will be retrieved).
DateTime
earliestLastUpdate
Dependsn/aRequired when query == UsersGetQuery.LastUpdate. Determines the earliest update date of users to return.
int
page
No0The page number of users to be returned.
int
pageSize
No50The number of users to be returned per page. This value cannot exceed the default.

Response Type

Array of User

/api/v2/users/ (HTTP GET)

Retrieves a user given its unique id.

Request Parameters

ParameterRequiredDescription
Guid
uid
YesThe unique id of the user to return.

Response Type

User

/api/v1/donations (HTTP GET)

Retrieves a paginated list of donations (requires access to Volunteer Fundraising feature)

Request Parameters

ParameterRequiredDefaultDescription
DonationsGetQuery 
query
Yesn/aThe type of query to use when searching donations.
Guid[]
uid
Yesn/aUnique ids of the users whose donations should be returned.
int 
page
No0The page number of the donations to be returned.
int 
pageSize
No50The number of donations to be returned per page. This value cannot exceed the default.

Response Type

Array of Donation