Member365 API Documentation
RESTful Contact Management API for Member365 Platform
Replace your-site with your organization's Member365 address.
Authentication
Read endpoints (GET) accept an API key/secret or an OAuth2 Bearer token. Write endpoints that create, update, or delete data require OAuth2 (Authorization: Bearer {token}) — they're marked OAuth2 required. API credentials are issued from the API Setup area of your Member365 CRM.
Contact API
Creates a new contact record. The email address (EmailAddress1) and member number must be unique across your account. Dates use YYYY-MM-DD format.
Parameters
| Name | Description |
|---|---|
|
firstName
string (body) |
Contact first name.
|
|
middleName
string (body) |
Contact middle name.
|
|
lastName
string (body) |
Contact last name.
|
|
birthDate
date (body) |
Date of birth (YYYY-MM-DD).
Example:
1990-05-01 |
|
EmailAddress1
string (body) |
Primary email address (must be unique; blank allowed).
Example:
jane@example.com |
|
phone1areacode
string (body) |
Primary phone area code.
|
|
phone1
string (body) |
Primary phone number.
|
|
phone1ext
string (body) |
Primary phone extension.
|
|
cellareacode
string (body) |
Mobile phone area code.
|
|
cell
string (body) |
Mobile phone number.
|
|
faxareacode
string (body) |
Fax area code.
|
|
fax
string (body) |
Fax number.
|
|
memberNumber
string (body) |
Member number (must be unique; blank allowed).
|
|
memberSince
date (body) |
Membership start date (YYYY-MM-DD).
Example:
2024-01-01 |
|
organizationID
int (body) |
Associated organization ID (see getOrganizations).
|
Deletes the contact with the given contactID. Depending on your account's configuration this is either a recoverable (soft) delete or a permanent one.
Parameters
| Name | Description |
|---|---|
|
contactID*
int (body) |
ID of the contact to delete.
|
Looks up a single contact by their primary email address. Useful for checking whether an email address is already in use before creating a contact.
Parameters
| Name | Description |
|---|---|
|
EmailAddress1*
string (query) |
Primary email address to search for.
Example:
jane@example.com |
Returns detailed information for contacts. You can filter the results to a single contact, a specific user, or one or more membership categories.
Parameters
| Name | Description |
|---|---|
|
contactID
int (query) |
Filter to a single contact by contactID.
|
|
userID
int (query) |
Filter by userID.
|
|
membershipCategoryID
int (query) |
Filter by membership category ID (accepts an array).
|
Returns a static sample contact record. Useful for verifying that your authentication and integration are set up correctly without touching real data.
Parameters
No parameters.
Returns a lightweight list of all contacts. Optionally filter to a single contact by contactID.
Parameters
| Name | Description |
|---|---|
|
contactID
int (query) |
Filter results to a single contact by ID.
|
Returns all organizations in your account. Use the returned organizationID values when creating or updating contacts.
Parameters
| Name | Description |
|---|---|
|
organizationID
int (query) |
Filter to a single organization by organizationID.
|
Updates an existing contact identified by contactID. Only the fields you supply are changed; everything else is left as is. Dates use YYYY-MM-DD format.
Parameters
| Name | Description |
|---|---|
|
contactID*
int (body) |
ID of the contact to update.
|
|
firstName
string (body) |
Contact first name.
|
|
middleName
string (body) |
Contact middle name.
|
|
lastName
string (body) |
Contact last name.
|
|
birthDate
date (body) |
Date of birth (YYYY-MM-DD).
Example:
1990-05-01 |
|
EmailAddress1
string (body) |
Primary email address (must be unique; blank allowed).
Example:
jane@example.com |
|
phone1areacode
string (body) |
Primary phone area code.
|
|
phone1
string (body) |
Primary phone number.
|
|
phone1ext
string (body) |
Primary phone extension.
|
|
cellareacode
string (body) |
Mobile phone area code.
|
|
cell
string (body) |
Mobile phone number.
|
|
faxareacode
string (body) |
Fax area code.
|
|
fax
string (body) |
Fax number.
|
|
memberNumber
string (body) |
Member number (must be unique; blank allowed).
|
|
memberSince
date (body) |
Membership start date (YYYY-MM-DD).
Example:
2024-01-01 |
|
organizationID
int (body) |
Associated organization ID (see getOrganizations).
|
Dashboard · Membership API
Returns your total number of active members and active contacts, along with recent growth: how many new members were activated and how many new contacts were added within the look-back window (30 days by default). The response also lists those new members and new contacts, newest first, with their names and email addresses.
Parameters
| Name | Description |
|---|---|
|
days
int (query) |
Look-back window in days for newly added contacts.
Default:
30 |
Returns memberships that have lapsed or are at risk of lapsing: a total count plus each affected member's name, email address, membership, status, and expiry date.
Parameters
No parameters.
Breaks your membership down by category for a chosen status: active (default), lapsed, pending applications, or pending renewals. Returns the overall total plus a count for each membership category. Ready-to-use chart data (doughnut, pie, or bar) is included when a chartType is supplied.
Parameters
| Name | Description |
|---|---|
|
status
text (query) |
Which membership application status to break down by category.
Allowed values: active, lapsed, applications-pending, renewals-pending · Default:
active |
|
chartType
text (query) |
Style of the included chart: doughnut, pie, or bar. If omitted or blank, no chart data is returned.
Allowed values: doughnut, pie, bar
|
An at-a-glance breakdown of your membership by status: Active, Lapsed, Pending, New This Month, and Other. The buckets always add up to the total. You can limit the snapshot to a single membership category, and ready-to-use chart data is included when a chartType is supplied.
Parameters
| Name | Description |
|---|---|
|
membershipCategoryID
int (query) |
Limit results to a single membership category. Omit for all categories.
|
|
chartType
text (query) |
Style of the included chart: doughnut, pie, or bar. If omitted or blank, no chart data is returned.
Allowed values: doughnut, pie, bar
|
Returns membership applications waiting for approval: a total count plus each applicant's name, email address, membership, and status.
Parameters
No parameters.
Returns active memberships expiring soon (within 30 days by default) that may need a follow-up: a total count plus each member's name, email address, membership, and expiry date.
Parameters
| Name | Description |
|---|---|
|
graceDays
int (query) |
How soon a membership must be expiring, in days, to appear as a follow-up.
Default:
30 |
Returns your total member count together with a list of the most recently activated members. The status option scopes both the count and the list to active members (default), lapsed members, or all members; for active members the response also includes a percent change versus the previous month. Summary figures cover genuinely new members — renewals are not counted as new — for the current period and year. The recent-member list is capped at 5 by default (up to 100) and can be restricted to activations within the last N days. Everything can be limited to a single membership category.
Parameters
| Name | Description |
|---|---|
|
membershipCategoryID
int (query) |
Limit results to a single membership category. Omit for all categories.
|
|
status
text (query) |
Membership state for the count + recent list: active (default), lapsed, or all.
Allowed values: active, lapsed, all · Default:
active |
|
recentLimit
int (query) |
How many recent members to list (1-100). Default 5.
Default:
5 |
|
days
int (query) |
Date-range window for the recent list: only members activated in the last N days. 0 = all-time (default).
Default:
0 |
|
chartType
text (query) |
Style of the trend chart: bar (default) or line.
Allowed values: bar, line · Default:
bar |
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Dashboard · Renewals & Billing API
Returns membership payments that failed or never completed: applications and renewals stuck waiting on a credit card payment. Includes the total count, the total outstanding dollar amount, and the number of members affected, plus a list of the affected invoices with each member's name, email address, and amount owing. The summary figures always cover the full set, even though the list itself shows at most 100 rows. Matches the Failed Credit Card Payments report in Member365.
Parameters
| Name | Description |
|---|---|
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Returns membership renewal reminder emails. The view option picks the slice: 'sent' (the default) lists reminders actually delivered over the last N days, with each email's engagement — whether it was opened, clicked, and whether the member went on to renew — and a preview of the email that was sent; 'scheduled' lists the reminders due to go out automatically over the next N days, with the template that will be used. Results can be limited to one membership category, and chart data of reminders over time is included.
Parameters
| Name | Description |
|---|---|
|
days
int (query) |
Window in days (1-365): the sent view looks back N days, the scheduled view looks ahead N days.
Default:
30 |
|
membershipCategoryID
int (query) |
Limit both views to a single membership category.
|
|
chartType
text (query) |
Style of the trend chart: bar (default) or line.
Allowed values: bar, line · Default:
bar |
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Returns active memberships due for renewal soon (within the next 7 days by default): a total count plus each member's name, email address, membership, and expiry date.
Parameters
| Name | Description |
|---|---|
|
days
int (query) |
Window in days from today.
Default:
7 |
Returns the number of active memberships expiring within the look-ahead window (30 days by default), with an approximate percent change versus the previous period. Includes a list of the ten members whose renewals are due soonest and chart data showing renewals due over time. Can be limited to a single membership category.
Parameters
| Name | Description |
|---|---|
|
days
int (query) |
Look-ahead window in days for renewals due.
Default:
30 |
|
membershipCategoryID
int (query) |
Limit results to a single membership category. Omit for all categories.
|
|
chartType
text (query) |
Style of the trend chart: bar (default) or line.
Allowed values: bar, line · Default:
bar |
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
A combined financial summary: revenue collected (with percent change), the dollar value of upcoming renewals, and counts of renewals pending payment, failed payments, open invoices, and pending refunds. All amounts are in dollars. By default revenue is month-to-date with a 30-day renewal look-ahead; supply days to use a rolling window instead.
Parameters
| Name | Description |
|---|---|
|
days
int (query) |
Window in days: revenue collected over the last N days and upcoming renewals over the next N; 0 or omitted = month-to-date revenue + 30-day renewal look-ahead.
Default:
0 |
Returns automatic recurring billing (ARB) charges scheduled within the look-ahead window (30 days by default): the total count, chart data of charges over time, and a list of the first 50 charges by date with each member's name, membership category, and charge date.
Parameters
| Name | Description |
|---|---|
|
days
int (query) |
Look-ahead window in days.
Default:
30 |
|
chartType
text (query) |
Style of the trend chart: bar (default) or line.
Allowed values: bar, line · Default:
bar |
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Returns automated membership renewal reminder emails scheduled to be sent within the look-ahead window (7 days by default): the total count plus a list of the first 50 by date, with each member's name, membership category, and reminder date.
Parameters
| Name | Description |
|---|---|
|
days
int (query) |
Look-ahead window in days.
Default:
7 |
|
chartType
text (query) |
Style of the trend chart: bar (default) or line.
Allowed values: bar, line · Default:
bar |
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Dashboard · Financial API
Returns your outstanding (unpaid) invoices grouped by how long they have been outstanding: 0-30, 31-60, 61-90, and over 90 days. Includes the overall total and a dollar amount per bucket, with optional chart data.
Parameters
| Name | Description |
|---|---|
|
chartType
text (query) |
Style of the breakdown chart: doughnut (default), pie, or bar.
Allowed values: doughnut, pie, bar · Default:
doughnut |
|
revenueType
text (query) |
Restrict to one revenue category. Leave blank for all.
Allowed values: membership, event, donation, job, store, tier, web, general
|
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Breaks membership revenue down by the kind of membership activity it came from: new members, renewals, reinstatements, and upgrades. Revenue that cannot be matched to a specific application is grouped under Other, so the buckets always add up to your total membership revenue. Covers all time by default, or the last N days when days is supplied. Includes optional chart data.
Parameters
| Name | Description |
|---|---|
|
chartType
text (query) |
Style of the breakdown chart: doughnut (default), pie, or bar.
Allowed values: doughnut, pie, bar · Default:
doughnut |
|
days
int (query) |
Window in days; 0 or omitted = all-time.
Default:
0 |
|
from
date (query) |
Start of an explicit date range (YYYY-MM-DD). Overrides days. Leave both blank for the rolling window.
|
|
to
date (query) |
End of an explicit date range (YYYY-MM-DD). Overrides days.
|
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Breaks successfully collected revenue down by payment method — credit card, cheque, cash, and so on (the methods available depend on how your account is configured). Covers all time by default, or a chosen window. Includes a dollar total per method and optional chart data.
Parameters
| Name | Description |
|---|---|
|
chartType
text (query) |
Style of the breakdown chart: doughnut (default), pie, or bar.
Allowed values: doughnut, pie, bar · Default:
doughnut |
|
days
int (query) |
Window in days; 0 or omitted = all-time.
Default:
0 |
|
revenueType
text (query) |
Restrict to one revenue category. Leave blank for all.
Allowed values: membership, event, donation, job, store, tier, web, general
|
|
from
date (query) |
Start of an explicit date range (YYYY-MM-DD). Overrides days. Leave both blank for the rolling window.
|
|
to
date (query) |
End of an explicit date range (YYYY-MM-DD). Overrides days.
|
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Returns unpaid and pending invoices awaiting reconciliation: a total count plus each invoice's name, amount, status, date, and the contact it belongs to.
Parameters
No parameters.
A single feed of recent financial activity: successful payments, refunds (shown as negative amounts), and declined charges. Each entry includes the date, contact, activity, revenue category, signed dollar amount, and status. Returns the 15 most recent entries by default (up to 50), optionally restricted to the last N days.
Parameters
| Name | Description |
|---|---|
|
limit
int (query) |
How many recent entries (1-50).
Default:
15 |
|
days
int (query) |
Window in days; 0 or omitted = most recent.
Default:
0 |
|
revenueType
text (query) |
Restrict to one revenue category. Leave blank for all.
Allowed values: membership, event, donation, job, store, tier, web, general
|
|
from
date (query) |
Start of an explicit date range (YYYY-MM-DD). Overrides days. Leave both blank for the rolling window.
|
|
to
date (query) |
End of an explicit date range (YYYY-MM-DD). Overrides days.
|
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Summarizes successful refunds: the total refunded amount broken down by revenue category, the number of refunds, and the refund rate (refunds as a percentage of revenue collected over the same window). Covers all time by default, or the last N days. Includes optional chart data.
Parameters
| Name | Description |
|---|---|
|
chartType
text (query) |
Style of the breakdown chart: doughnut (default), pie, or bar.
Allowed values: doughnut, pie, bar · Default:
doughnut |
|
days
int (query) |
Window in days; 0 or omitted = all-time.
Default:
0 |
|
revenueType
text (query) |
Restrict to one revenue category. Leave blank for all.
Allowed values: membership, event, donation, job, store, tier, web, general
|
|
from
date (query) |
Start of an explicit date range (YYYY-MM-DD). Overrides days. Leave both blank for the rolling window.
|
|
to
date (query) |
End of an explicit date range (YYYY-MM-DD). Overrides days.
|
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Returns successful payment transactions over a date range (the current month by default): the summed total plus each transaction's invoice, amount, date, and contact.
Parameters
| Name | Description |
|---|---|
|
from
date (query) |
Start date (YYYY-MM-DD). Defaults to the start of the current month.
|
|
to
date (query) |
End date (YYYY-MM-DD). Defaults to today.
|
Breaks successfully collected revenue down by category — membership, events, donations, store, job postings, and so on. Covers all time by default, or a chosen window. Includes a dollar total per category and optional chart data.
Parameters
| Name | Description |
|---|---|
|
chartType
text (query) |
Style of the breakdown chart: doughnut (default), pie, or bar.
Allowed values: doughnut, pie, bar · Default:
doughnut |
|
days
int (query) |
Window in days; 0 or omitted = all-time.
Default:
0 |
|
revenueType
text (query) |
Restrict to one revenue category. Leave blank for all.
Allowed values: membership, event, donation, job, store, tier, web, general
|
|
from
date (query) |
Start of an explicit date range (YYYY-MM-DD). Overrides days. Leave both blank for the rolling window.
|
|
to
date (query) |
End of an explicit date range (YYYY-MM-DD). Overrides days.
|
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Returns revenue as a trend over time, with one series per revenue category, automatically grouped by day, week, or month depending on the window (the default 365-day window is grouped monthly). The top five categories get their own series and the rest are combined into Other. Ready-to-use line-chart data is included.
Parameters
| Name | Description |
|---|---|
|
days
int (query) |
Window in days. The trend is grouped automatically: monthly for long windows (the 365-day default), weekly for 210 days or less, daily for 45 days or less.
Default:
365 |
|
revenueType
text (query) |
Restrict to one revenue category. Leave blank for all.
Allowed values: membership, event, donation, job, store, tier, web, general
|
|
from
date (query) |
Start of an explicit date range (YYYY-MM-DD). Overrides days. Leave both blank for the rolling window.
|
|
to
date (query) |
End of an explicit date range (YYYY-MM-DD). Overrides days.
|
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Returns collected revenue as a dashboard statistic: the dollar total with an approximate percent change versus the previous period, chart data of revenue over time, and a list of the ten most recent payments with contact name, amount, and date. Month-to-date by default, or a rolling N-day window. Can be restricted to a single invoice type (general, membership, tier, event registration, job posting, web, or fundraising).
Parameters
| Name | Description |
|---|---|
|
days
int (query) |
Rolling revenue window in days (last N days vs the prior N); 0 or omitted = month-to-date vs last month.
Default:
0 |
|
invoiceType
text (query) |
Restrict revenue to one invoice type: INVOICE (general), MR (membership), TP (tier), ER (event registration), JOB (job posting), WEB (web invoice), or FUND (fundraising). Omit for all types.
Allowed values: INVOICE, MR, TP, ER, JOB, WEB, FUND
|
|
chartType
text (query) |
Style of the trend chart: bar (default) or line.
Allowed values: bar, line · Default:
bar |
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Dashboard · Events API
An overview of event activity: upcoming event count, registrations, event revenue with percent change, waitlisted registrations, unpaid registrations, and a day-by-day registration trend over the window (60 days by default). Supply an eventID to scope every figure to a single event. Chart data is included when a chartType is supplied.
Parameters
| Name | Description |
|---|---|
|
days
int (query) |
Number of days of registration history to include in the trend.
Default:
60 |
|
eventID
int (query) |
Scope every figure to a single event. Omit (or 0) for all events.
|
|
chartType
text (query) |
Style of the included trend chart: line or bar. If omitted or blank, no chart data is returned.
Allowed values: line, bar
|
Works in two modes. Without an eventID it lists all of your events, newest first, each with its registration count, collected revenue, and pending revenue. With an eventID it returns that event's full breakdown: registrations, tickets sold, withdrawals, collected and pending revenue, and whether registration is currently open. Figures are calculated the same way in both modes, so a row in the list always matches the detailed breakdown of the same event.
Parameters
| Name | Description |
|---|---|
|
eventID
int (query) |
Show a single event's breakdown. Omit to list all events instead.
|
|
limit
int (query) |
Max events listed when eventID is omitted (1-200).
Default:
50 |
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Returns upcoming published events, each with its number of registrations and its capacity.
Parameters
| Name | Description |
|---|---|
|
limit
int (query) |
Maximum number of events to return.
Default:
5 |
|
days
int (query) |
Optional window in days from today.
|
Dashboard · Communications API
Returns your email marketing statistics: campaigns sent, open rate, click rate, bounces, unsubscribes, and total recipients, opens, and clicks (rates are percentages of recipients). Covers all time by default, or campaigns sent in the last N days. Also lists your five most recent campaigns, and can be scoped to a single campaign (bounces are not tracked per campaign). Ready-to-use gauge chart data for the open rate is included.
Parameters
| Name | Description |
|---|---|
|
days
int (query) |
Send-date window in days; 0 = all-time.
Default:
0 |
|
eCommunicationID
int (query) |
Scope the statistics to a single sent campaign. Omit (or 0) for all campaigns.
|
Returns email campaigns scheduled to go out from today through the look-ahead window (30 days by default): a count plus up to ten campaigns, soonest first, each with its scheduled delivery date and an estimated recipient count. Chart data of the recipient estimates is included.
Parameters
| Name | Description |
|---|---|
|
days
int (query) |
Look-ahead window in days (queued campaigns due from today through the window).
Default:
30 |
|
chartType
text (query) |
Style of the estimated-recipients chart: bar (default) or line.
Allowed values: bar, line · Default:
bar |
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Dashboard · Contacts & Engagement API
Works in two modes. Without a listID it returns your contact lists (from List Builder) with each list's name and access level. With a listID it returns the contacts on that list — name, email address, organization, and addresses — up to the requested limit. You will see the lists you own plus shared lists; API calls without an admin context see shared lists only.
Parameters
| Name | Description |
|---|---|
|
listID
int (query) |
The contact list to expand. Omit to get the catalog of your lists instead.
|
|
limit
int (query) |
Max contacts returned when listID is set (1-100).
Default:
20 |
|
columns
array (query) |
Comma-separated display columns to include when listID is set. Available keys: name, email, organization, phone, mobile, jobTitle, memberNumber, resAddress, resCity, resLocation, resCountry, resPostal, busAddress, busCity, busLocation, busCountry, busPostal. Invalid keys are ignored.
Default:
name,email,organization |
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Returns daily aggregated engagement activity over the window (30 days by default): total engagement score, active users, and actions — the same series charted on the Engagement Analytics page. Chart data is included when a chartType is supplied.
Parameters
| Name | Description |
|---|---|
|
days
int (query) |
Aggregation window in days.
Default:
30 |
|
chartType
text (query) |
Style of the included chart: line or bar. If omitted or blank, no chart data is returned.
Allowed values: line, bar
|
Returns recent responses for a form (requires a formID; without one the response simply indicates that no form has been selected). Includes the total number of completed responses, a summary chart for every multiple-choice question flagged for analytics, and the most recent respondents (5 by default, up to 500). The respondentType option scopes everything to contact submissions, anonymous web submissions, or both.
Parameters
| Name | Description |
|---|---|
|
formID
int (query) |
The form to return responses for. If omitted, the response simply indicates that no form has been selected.
|
|
chartType
text (query) |
Style of each per-question summary chart: pie (default), doughnut, or bar.
Allowed values: pie, doughnut, bar · Default:
pie |
|
respondentType
text (query) |
Which respondents to include: contacts (submissions linked to a contact record), web (anonymous web submissions), or all (default).
Allowed values: all, contacts, web · Default:
all |
|
respondentLimit
int (query) |
How many recent respondents to list (1-500). Default 5.
Default:
5 |
|
search
text (query) |
Free-text search that filters the returned list — by contact name, email address, invoice number, category, or dollar amount, as appropriate to the endpoint. Only the list is filtered; counts, totals, and charts still reflect the full data set.
|
Returns a feed of recent activity across your account, plus a breakdown of that activity by type with optional chart data.
Parameters
| Name | Description |
|---|---|
|
limit
int (query) |
Maximum number of activity items to return.
Default:
10 |
|
days
int (query) |
Window in days for the activity-type breakdown. 0 (the default) uses the most recent 500 events instead, so the breakdown always has data.
Default:
0 |
|
chartType
text (query) |
Style of the activity-type breakdown chart (top 5 activity types plus Other): doughnut (default), pie, or bar.
Allowed values: doughnut, pie, bar · Default:
doughnut |
Dashboard · System & Tasks API
Returns every dashboard alert applicable to your account, including those currently at zero. Each alert has a label, severity, count, and a link to the page it relates to. Counts come from the same source as the classic dashboard, so the numbers always match the pages they point at.
Parameters
No parameters.
Reports on the nightly automated maintenance run — the daily tasks that process billing, memberships, events, communications, and data cleanup. The group option picks the slice: 'overview' (the default) returns the overall outcome of the last run (completed, failed, incomplete, or never run) with timing and per-status counts; the other groups (billing, membership, events, communications, data) return each task in that group with its status — ran, disabled, skipped, failed, not reached, and so on — an explanatory detail line, and a measurable outcome figure where one exists (for example, emails sent or members lapsed on the run day).
Parameters
| Name | Description |
|---|---|
|
group
text (query) |
Which slice of the nightly maintenance report to return: overview (default) or one task group.
Allowed values: overview, billing, membership, events, communications, data · Default:
overview |
Returns onboarding tasks that are not yet done: a count plus each task's name, status, and the task list it belongs to.
Parameters
No parameters.
Returns live system figures: how many administrators and members are currently online, and your account's disk usage.
Parameters
No parameters.
Returns open onboarding and staff tasks that are not yet done, optionally filtered by assignee and status.
Parameters
| Name | Description |
|---|---|
|
assignTo
string (query) |
Filter by assignee.
|
|
status
string (query) |
Filter by task status.
Allowed values: not started, in-progress, ready-for-review, done
|
|
limit
int (query) |
Maximum number of tasks to return.
|
Updates the status of a task. This is a write operation and requires OAuth2 authentication.
Parameters
| Name | Description |
|---|---|
|
obTaskID*
int (body) |
ID of the task to update.
|
|
status*
string (body) |
New task status.
Allowed values: not started, in-progress, ready-for-review, done
|
Form API
Returns the structure of the signup form for the directory identified by directoryID.
Parameters
| Name | Description |
|---|---|
|
directoryID*
int (query) |
ID of the directory to retrieve the basic form for.
|
Returns your roster of member contacts with their organization details. For each contact who submitted the form identified by formID, their answers are merged into their row — but only for questions whose alias is set to "API" in the form builder. Use this when you want the full contact list with form answers attached; use getFormDataBasic when you only want the people who submitted the form.
Parameters
| Name | Description |
|---|---|
|
formID*
int (query) |
ID of the form whose submitted responses are merged into each contact row.
|
Returns one row per contact who submitted the form identified by formID, with their contact and organization details. Answers are included only for form questions whose alias is set to "API" in the form builder. Unlike getFormData, only submitters are included — not the full member roster.
Parameters
| Name | Description |
|---|---|
|
formID*
int (query) |
ID of the form whose submitters and responses to return.
|
Import API
Lists your account's contact classifications (also called demographics). Import tools such as the Member365 Import Assistant check the classifications in a spreadsheet against this list before uploading.
Parameters
No parameters.
Returns a paginated list of your existing contacts — contact ID, email address, and member number — with pagination details (500 per page by default, up to 1000). Lets an import tool cross-reference a spreadsheet against the contacts already in your account before uploading.
Parameters
| Name | Description |
|---|---|
|
limit
int (query) |
Number of contacts per page (up to 1000).
Default:
500 |
|
offset
int (query) |
Number of contacts to skip. Use together with limit to page through results.
Default:
0 |
Lists your account's gender and pronoun options. Import spreadsheets are validated against this list, because rows with unrecognized values are rejected at import.
Parameters
No parameters.
Lists your membership categories with their English and French labels, each category's renewal term, and whether it is a lifetime category. Import spreadsheets are validated against this list — category names match either language, case-insensitively — because categories cannot be created automatically during an import.
Parameters
No parameters.
Lists your account's salutations. Import spreadsheets are checked against this list; unrecognized salutations are advisory only, because Member365 creates them automatically at import.
Parameters
No parameters.
Lists your account's tags for the given type: contact tags or organization tags. Tags are created automatically during an import, so this list is informational rather than a hard validation.
Parameters
| Name | Description |
|---|---|
|
type*
text (query) |
Which tags to list: contact tags or organization tags.
Allowed values: contacts, organizations · Example:
contacts |
Returns basic information about your account: country, default currency, and the email-consent regime that applies to it (CASL for Canada, CAN-SPAM for the United States, or Other). A good first call for verifying connectivity.
Parameters
No parameters.
Secure Authentication | Rate Limited | HTTPS Required
