Passa al contenuto principale

Objects

AccessToken

The access token of a private application, to be sent as a bearer token when calling the API.

Fields

NameDescription
token
String!

The token itself. Shown once, on creation or refresh.

Activity

A task to do on a supporter or a donation, assigned to a staff member and marked as done once carried out.

Fields

NameDescription
id
Int!

Unique identifier of the activity.

createDate
DateTime!

When the activity was created.

updateDate
DateTime!

When the activity was last modified.

category
ActivityCategory!

Kind of task to carry out.

deadlineDate
Date

Day the task is due. Null when it has no deadline.

doneDate
Date

Day the task was carried out. Null while it is still open.

note
String

Free-text note describing the task or its outcome.

staff
ActivityStaff!

Staff member the task is assigned to.

ActivityConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[ActivityEdge!]!

Items of this page, in the order defined by the query.

ActivityEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
Activity!

The item itself.

ActivityResponse

Result of an activity mutation: the activity on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

activity
Activity

The activity as persisted after the mutation. Null when userErrors is not empty.

ActivityStaff

The staff member an activity is assigned to, reduced to what is needed to show them in a list.

Fields

NameDescription
id
Int!

Identifier of the membership.

name
String!

Display name of the staff member.

email
String!

Email address of the staff member.

Application

An OAuth2 application: a channel or an integration that talks to the API on behalf of an organization, such as the donation widget, a kiosk or a partner app.

Fields

NameDescription
id
Int!

Unique identifier of the application.

name
String!

Name of the application, shown when asking the organization to install it.

description
String

What the application does, shown on its installation page.

logoUrl
String

URL of the logo of the application.

type
ApplicationType!

Kind of application: private, public or one of the applications of Riseact.

appUrl
String

URL the application is opened at once installed.

installUrl
String

URL the installation flow of the application starts at.

authorName
String

Name of who publishes the application.

authorHomepageUrl
String

Site of who publishes the application.

authorEmail
String

Support address of who publishes the application.

isEmbedded
Boolean!

Whether the application is shown inside the Riseact back-office instead of on its own site.

permissions
[StaffPermission!]!

Permissions the application asks the organization for.

clientId
String!

OAuth2 client identifier of the application.

clientSecret
String!

OAuth2 client secret of the application. Treat it as a credential and never expose it to a browser.

partner
String

Name of the agency publishing the application. Null for private apps and for the applications of Riseact.

accessToken
AccessToken!

Access token of the application for this organization, for private apps that call the API without going through the OAuth2 flow.

isInstalled
Boolean!

Whether the organization has installed the application.

AppMutation

Entry point of the admin API: everything an application can change in an organization.

Fields

NameDescription
articlesCreate
ArticlesResponse!

Publishes a post in one of the blogs of the site.

Arguments

NameDescription
data
ArticleInput!
articlesUpdate
ArticlesResponse!

Updates the fields of the post that are present in the input.

Arguments

NameDescription
id
Int!
data
ArticleInput!
articlesDelete
ArticlesResponse!

Deletes the post.

Arguments

NameDescription
id
Int!
activityCreate
ActivityResponse!

Creates a task on a supporter or a donation.

Arguments

NameDescription
data
ActivityCreateInput!
activityDone
ActivityResponse!

Marks the task as carried out today.

Arguments

NameDescription
id
Int!
activityUndone
ActivityResponse!

Reopens a task that had been marked as done.

Arguments

NameDescription
id
Int!
activityUpdate
ActivityResponse!

Updates the fields of the task that are present in the input.

Arguments

NameDescription
id
Int!
data
ActivityUpdateInput!
activityDelete
ActivityResponse!

Deletes the task.

Arguments

NameDescription
id
Int!
blogsCreate
BlogsResponse!

Creates a blog on the public site.

Arguments

NameDescription
data
BlogInput!
blogsUpdate
BlogsResponse!

Updates the fields of the blog that are present in the input.

Arguments

NameDescription
id
Int!
data
BlogInput!
blogsDelete
BlogsResponse!

Deletes the blog together with its posts.

Arguments

NameDescription
id
Int!
campaignCreate
CampaignResponse!

Creates a campaign together with its public page. Requires the CAMPAIGN_WRITE permission.

Arguments

NameDescription
data
CampaignInput!
campaignDuplicate
CampaignResponse!

Creates a copy of the campaign, its form configuration and its cost examples. The copy starts hidden. Requires the CAMPAIGN_WRITE permission.

Arguments

NameDescription
id
Int!
campaignUpdate
CampaignResponse!

Updates the fields of the campaign that are present in the input. Requires the CAMPAIGN_WRITE permission.

Arguments

NameDescription
id
Int!
data
CampaignInput!
campaignDelete
CampaignResponse!

Deletes the campaign. Fails when donations are already attached to it. Requires the CAMPAIGN_WRITE permission.

Arguments

NameDescription
id
Int!
campaignCommentCreate
CampaignCommentResponse!

Attaches a comment to a donation. Requires the CAMPAIGN_WRITE permission.

Arguments

NameDescription
data
CampaignCommentCreateInput!
campaignCommentUpdate
CampaignCommentResponse!

Moderates or edits a comment. Requires the CAMPAIGN_WRITE permission.

Arguments

NameDescription
id
Int!
data
CampaignCommentUpdateInput!
campaignCommentDelete
CampaignCommentResponse!

Deletes the comment. Requires the CAMPAIGN_WRITE permission.

Arguments

NameDescription
id
Int!
peerCampaignCreate
PeerCampaignResponse!

Opens a peer-to-peer page for a supporter on one of the campaigns that allow it. Requires the CAMPAIGN_WRITE permission.

Arguments

NameDescription
data
PeerCampaignInput!
peerCampaignUpdate
PeerCampaignResponse!

Updates the fields of the peer page that are present in the input. Requires the CAMPAIGN_WRITE permission.

Arguments

NameDescription
id
Int!
data
PeerCampaignInput!
peerCampaignDelete
PeerCampaignResponse!

Deletes the peer page. Requires the CAMPAIGN_WRITE permission.

Arguments

NameDescription
id
Int!
checkoutCreate
CheckoutResponse!

Opens a checkout session and returns it, token included.

Arguments

NameDescription
data
CheckoutInput!
checkoutUpdate
CheckoutResponse!

Updates the fields of the session that are present in the input, as the donor advances through the form.

Arguments

NameDescription
token
String!
data
CheckoutInput!
checkoutComplete
CheckoutResponse!

Closes the session, creating the supporter and the donation out of the data it holds.

Arguments

NameDescription
token
String!
data
CheckoutCompleteInput!
checkoutRegisterPayment
CheckoutResponse!

Records against the session the payment collected by the gateway, and settles the resulting donation.

Arguments

NameDescription
token
String!
data
CheckoutPaymentInput!
checkoutSendRecoveryEmail
CheckoutResponse!

Sends the donor an email with a link to resume the abandoned session.

Arguments

NameDescription
token
String!
donationUpdate
Donation!

Updates the editable fields of a donation. Requires the DONATION_WRITE permission.

Arguments

NameDescription
id
Int!
data
DonationInput!
donationExport
String!

Starts an asynchronous export of the donations matching the given domain and returns the email address the file will be sent to. Requires the DONATION_EXPORT permission.

Arguments

NameDescription
format
ExportFormat!
domain
DonationDomain!
donationReceiptSend
Boolean!

Generates the tax receipt of the donation and sends it to the supporter. Returns whether the message was actually sent. Requires the DONATION_WRITE permission.

Arguments

NameDescription
id
Int!
donationRegisterPayment
DonationResponse!

Registers a payment collected outside Riseact against the donation, for example a bank transfer. Requires the DONATION_WRITE permission.

Arguments

NameDescription
id
Int!
data
DonationPaymentInput!
donationImport
ImportRun!

Uploads a file of donations and starts an asynchronous import run, returning the run to poll for progress. Requires the DONATION_WRITE permission.

Arguments

NameDescription
file
Upload!
fallbackCampaignId
Int
donationRevoke
Donation!

Revokes the pledge, stopping any future collection. Already revoked donations are returned unchanged. Requires the DONATION_WRITE permission.

Arguments

NameDescription
id
Int!
donationDelete
Donation!

Deletes the donation and returns the record as it was before deletion. Requires the DONATION_WRITE permission.

Arguments

NameDescription
id
Int!
mediaCreate
Media!

Uploads an image and returns it with its derived sizes.

Arguments

NameDescription
file
Upload!
mediaDelete
MediaResponse!

Deletes an image. Records still pointing at it lose their picture.

Arguments

NameDescription
id
Int!
menuCreate
MenuResponse!

Creates a navigation menu with its entries.

Arguments

NameDescription
data
MenuInput!
menuUpdate
MenuResponse!

Updates the menu and replaces its entries with the ones sent.

Arguments

NameDescription
id
Int!
data
MenuInput!
menuDelete
MenuResponse!

Deletes the menu. A theme still calling its handle finds nothing.

Arguments

NameDescription
id
Int!
organizationUpdate
OrganizationResponse!

Updates the profile, the contacts and the certificate settings of the organization.

Arguments

NameDescription
data
OrganizationInput!
organizationUpdateLegalData
OrganizationResponse!

Updates the terms of service, the privacy policy and the default consents of the organization.

Arguments

NameDescription
data
OrganizationLegalInput!
terminalLocationCreate
StripeTerminalLocation!

Creates a location card readers can be installed at.

Arguments

NameDescription
data
TerminalLocationInput!
terminalLocationUpdate
StripeTerminalLocation!

Updates the address of a location.

Arguments

NameDescription
id
String!
data
TerminalLocationInput!
terminalLocationDelete
Void

Deletes a location. The readers installed there must be moved first.

Arguments

NameDescription
id
String!
terminalRegister
StripeTerminal!

Pairs a card reader with the organization, using the code shown on its screen.

Arguments

NameDescription
data
TerminalRegisterInput!
terminalUpdateLabel
StripeTerminal!

Renames a card reader.

Arguments

NameDescription
id
String!
label
String!
terminalDelete
String!

Unpairs a card reader and returns its identifier.

Arguments

NameDescription
id
String!
terminalConnectionTokenCreate
String!

Issues a short-lived token the kiosk application uses to talk to the card readers.

Arguments

NameDescription
locationId
String
pagesCreate
PagesResponse!

Creates a static page on the public site.

Arguments

NameDescription
data
PageInput!
pagesUpdate
PagesResponse!

Updates the fields of the page that are present in the input.

Arguments

NameDescription
id
Int!
data
PageInput!
pagesDelete
PagesResponse!

Deletes the page.

Arguments

NameDescription
id
Int!
manualPaymentMethodCreate
PaymentMethodResponse!

Creates a payment method collected outside Riseact.

Arguments

NameDescription
data
ManualPaymentMethodInput!
manualPaymentMethodUpdate
PaymentMethodResponse!

Updates a manual payment method.

Arguments

NameDescription
id
Int!
data
ManualPaymentMethodInput!
manualPaymentMethodDelete
PaymentMethodResponse!

Deletes a manual payment method. Payments already collected with it are left untouched.

Arguments

NameDescription
id
Int!
paymentExport
String!

Starts an asynchronous export of the payments matching the given domain and returns the email address the file will be sent to.

Arguments

NameDescription
format
ExportFormat!
domain
PaymentDomain!
paymentUpdate
PaymentResponse!

Corrects the editable fields of a payment.

Arguments

NameDescription
id
Int!
data
ManualPaymentInput!
paymentRefund
PaymentResponse!

Refunds the payment on the gateway that collected it and records the refund.

Arguments

NameDescription
id
Int!
satispayPaymentCreate
SatispayPaymentResponse!

Opens a Satispay payment for the checkout session and returns what the donor needs to pay it.

Arguments

NameDescription
checkoutToken
String!
projectCreate
ProjectResponse!

Creates a project together with its public page.

Arguments

NameDescription
data
ProjectInput!
projectUpdate
ProjectResponse!

Updates the fields of the project that are present in the input.

Arguments

NameDescription
id
Int!
data
ProjectInput!
projectUpdateItems
ProjectResponse!

Replaces the campaigns listed in the project, in the given order. Only for projects listed by hand.

Arguments

NameDescription
id
Int!
campaignIds
[Int!]!
projectRemoveItem
ProjectResponse!

Removes one campaign from a project listed by hand.

Arguments

NameDescription
id
Int!
campaignId
Int!
projectDelete
ProjectResponse!

Deletes the project. The campaigns it gathers are left untouched.

Arguments

NameDescription
id
Int!
supporterCreate
Supporter!

Creates a supporter. Requires the SUPPORTER_WRITE permission.

Arguments

NameDescription
data
SupporterInput!
supporterLeadCreate
Supporter!

Creates a supporter as a lead, i.e. a contact acquired before any donation. Requires the SUPPORTER_WRITE permission.

Arguments

NameDescription
data
LeadSupporterInput!
supporterUpdate
Supporter!

Updates the fields of a supporter that are present in the input. Requires the SUPPORTER_WRITE permission.

Arguments

NameDescription
id
Int!
data
SupporterInput!
supporterDelete
Supporter!

Deletes the supporter and returns the record as it was before deletion. Requires the SUPPORTER_WRITE permission.

Arguments

NameDescription
id
Int!
supporterSendTaxCertificate
Supporter!

Generates the yearly tax certificate of the supporter and delivers it over the chosen channel. Requires the SUPPORTER_WRITE permission.

Arguments

NameDescription
id
Int!
method
NotificationMethods!
supporterImport
ImportRun!

Uploads a file of supporters and starts an asynchronous import run, returning the run to poll for progress. Requires the SUPPORTER_WRITE permission.

Arguments

NameDescription
file
Upload!
supporterBulkTags
Boolean!

Adds or removes the given labels on every supporter matching the filters. Requires the SUPPORTER_WRITE permission.

Arguments

NameDescription
action
SupporterBulkTagAction!
filters
SupporterFiltersInput!
tags
[String!]!
supporterExport
String!

Starts an asynchronous export of the supporters matching the given domain and returns the email address the file will be sent to. Requires the SUPPORTER_EXPORT permission.

Arguments

NameDescription
format
ExportFormat!
domain
SupporterDomain!
supporterMerge
Supporter!

Merges the duplicate supporters into the master one, moving their donations and history, and applies the given data to the result. Requires the SUPPORTER_WRITE permission.

Arguments

NameDescription
masterId
Int!
duplicatesIds
[Int!]!
data
SupporterInput!
supporterSetPrivacy
SupporterResponse!

Records a consent on the supporter, replacing any previous value for the same privacy definition. Requires the SUPPORTER_WRITE permission.

Arguments

NameDescription
id
Int!
data
SupporterPrivacyInput!
supporterRemovePrivacy
SupporterResponse!

Removes the consent identified by the given code from the supporter. Requires the SUPPORTER_WRITE permission.

Arguments

NameDescription
id
Int!
code
String!
segmentCreate
SegmentResponse!

Saves a set of filters as a segment.

Arguments

NameDescription
data
SegmentInput!
segmentUpdate
SegmentResponse!

Updates the name or the filters of a segment.

Arguments

NameDescription
id
Int!
data
SegmentInput!
segmentDelete
SegmentResponse!

Deletes a segment.

Arguments

NameDescription
id
Int!
stripeActivate
StripeAccount!

Creates the Stripe connected account of the organization, or returns the one it already has.

stripeGenerateOnboardingLink
StripeLink!

Opens a link to the Stripe onboarding, where the organization submits the details Stripe needs to let it take payments.

stripeGenerateDashboardLink
StripeLink!

Opens a link to the Stripe dashboard of the connected account.

stripeCheckoutIntentCreate
StripeCheckoutResponse!

Opens a Stripe payment for the checkout session and returns the intent for the browser to confirm.

Arguments

NameDescription
checkoutToken
String!
paymentTypes
StripePaymentTypeInput!
stripeTerminalCheckoutIntentCreate
StripeCheckoutResponse!

Opens a Stripe payment for the checkout session, to be collected on a card reader instead of in a browser.

Arguments

NameDescription
checkoutToken
String!
sumupAccountCreate
SumUpAccount!

Connects a SumUp merchant to the organization.

Arguments

NameDescription
data
SumUpAccountInput!
sumupAccountUpdate
SumUpAccount!

Changes the SumUp merchant connected to the organization.

Arguments

NameDescription
data
SumUpAccountInput!
redirectsCreate
RedirectResponse!

Creates a redirect on the public site.

Arguments

NameDescription
data
RedirectInput!
redirectsUpdate
RedirectResponse!

Updates the path or the destination of a redirect.

Arguments

NameDescription
id
Int!
data
RedirectInput!
redirectsDelete
RedirectResponse!

Deletes the redirect, so the old address stops being forwarded.

Arguments

NameDescription
id
Int!
customfieldDefinitionCreate
CustomFieldDefinitionResponse!

Adds a custom field to one kind of record.

Arguments

NameDescription
data
CustomFieldDefinitionCreateInput!
customfieldDefinitionUpdate
CustomFieldDefinitionResponse!

Updates the label, the hint, the options or the position of a custom field.

Arguments

NameDescription
id
Int!
data
CustomFieldDefinitionUpdateInput!
customfieldDefinitionDelete
CustomFieldDefinitionResponse!

Deletes a custom field definition together with the values recorded under it.

Arguments

NameDescription
id
Int!
privacyDefinitionCreate
PrivacyDefinitionResponse!

Adds a consent to the ones the organization asks donors for.

Arguments

NameDescription
data
PrivacyDefinitionCreateInput!
privacyDefinitionUpdate
PrivacyDefinitionResponse!

Updates a consent definition. Consents already recorded on supporters are left untouched.

Arguments

NameDescription
id
Int!
data
PrivacyDefinitionUpdateInput!
privacyDefinitionDelete
PrivacyDefinitionResponse!

Deletes a consent definition.

Arguments

NameDescription
id
Int!

AppQuery

Entry point of the admin API: everything an application can read from an organization.

Fields

NameDescription
activities
ActivityConnection!

Paginated list of the activities of the organization.

Arguments

NameDescription
pagination
PaginationInput
filters
ActivityFilters
activity
Activity!

A single activity by id.

Arguments

NameDescription
id
Int!
articles
ArticleConnection!

Paginated list of the blog posts of the organization.

Arguments

NameDescription
pagination
PaginationInput
filters
ArticlesFiltersInput
article
Article!

A single blog post by id.

Arguments

NameDescription
id
Int!
blogs
BlogConnection!

Paginated list of the blogs of the organization.

Arguments

NameDescription
pagination
PaginationInput
filters
BlogsFiltersInput
blog
Blog!

A single blog by id.

Arguments

NameDescription
id
Int!
campaigns
CampaignConnection!

Paginated list of the campaigns of the organization. Requires the CAMPAIGN_READ permission.

Arguments

NameDescription
pagination
PaginationInput
filters
CampaignFilters
campaign
Campaign!

A single campaign by id. Requires the CAMPAIGN_READ permission.

Arguments

NameDescription
id
Int!
campaignTags
StrConnection!

Paginated list of the labels used on campaigns, for autocompletion and filtering. Requires the CAMPAIGN_READ permission.

Arguments

NameDescription
pagination
PaginationInput
q
String
campaignComments
CampaignCommentConnection!

Paginated list of the comments left by donors, whatever their moderation state. Requires the CAMPAIGN_READ permission.

Arguments

NameDescription
pagination
PaginationInput
filters
CampaignCommentsFilters
campaignComment
CampaignComment!

A single comment by id. Requires the CAMPAIGN_READ permission.

Arguments

NameDescription
id
Int!
peerCampaigns
PeerCampaignConnection!

Paginated list of the peer-to-peer pages of the organization. Requires the CAMPAIGN_READ permission.

Arguments

NameDescription
pagination
PaginationInput
filters
PeerCampaignFilters
peerCampaign
PeerCampaign!

A single peer-to-peer page by id. Requires the CAMPAIGN_READ permission.

Arguments

NameDescription
id
Int!
checkouts
CheckoutConnection!

Paginated list of the checkout sessions of the organization.

Arguments

NameDescription
pagination
PaginationInput
filters
CheckoutFilters
checkoutsAbandoned
CheckoutConnection!

Paginated list of the sessions the donor left open without completing them, the ones a recovery email can be sent for.

Arguments

NameDescription
pagination
PaginationInput
filters
CheckoutFilters
checkoutsAdminGenerated
CheckoutConnection!

Paginated list of the promises, i.e. the sessions opened by an operator for a donation to be paid later.

Arguments

NameDescription
pagination
PaginationInput
filters
CheckoutFilters
checkout
Checkout!

A single checkout session by token.

Arguments

NameDescription
token
String!
donations
DonationConnection!

Paginated list of the donations of the organization, newest first. Requires the DONATION_READ permission.

Arguments

NameDescription
pagination
PaginationInput
filters
DonationFiltersInput
donation
Donation!

A single donation by id. Requires the DONATION_READ permission.

Arguments

NameDescription
id
Int!
donationTags
StrConnection!

Paginated list of the labels used on donations, for autocompletion and filtering. Requires the DONATION_READ permission.

Arguments

NameDescription
pagination
PaginationInput
q
String
importRuns
[ImportRun!]!

Import runs of the organization, newest first. Requires the SUPPORTER_READ permission.

importRun
ImportRun

A single import run by id. Requires the SUPPORTER_READ permission.

Arguments

NameDescription
id
Int!
media
MediaConnection!

Paginated list of the images uploaded by the organization, newest first.

Arguments

NameDescription
pagination
PaginationInput
mediaSingle
Media!

A single image by id.

Arguments

NameDescription
id
Int!
menus
[Menu!]!

Navigation menus of the site.

menu
Menu!

A single menu by id.

Arguments

NameDescription
id
Int!
menuByHandle
Menu!

A single menu by the handle the theme calls it by.

Arguments

NameDescription
handle
String!
organizations
[Organization!]!

Organizations the signed-in user is staff of.

Arguments

NameDescription
filters
OrganizationsFilters
organization
Organization!

The organization the request is addressed to, resolved from the host or from the access token.

owner
Staff!

Staff member owning the organization.

pages
PageConnection!

Paginated list of the static pages of the site.

Arguments

NameDescription
pagination
PaginationInput
filters
PagesFiltersInput
page
Page!

A single page by id.

Arguments

NameDescription
id
Int!
paymentMethods
[PaymentMethod!]!

Every payment method available to the organization, gateways and manual methods alike.

manualPaymentMethods
[PaymentMethod!]!

Only the payment methods collected outside Riseact.

manualPaymentMethod
PaymentMethod!

A single manual payment method by id.

Arguments

NameDescription
id
Int!
payments
PaymentConnection!

Paginated list of the payments of the organization, newest first.

Arguments

NameDescription
pagination
PaginationInput
filters
PaymentFiltersInput
payment
Payment!

A single payment by id.

Arguments

NameDescription
id
Int!
projects
ProjectConnection!

Paginated list of the projects of the organization.

Arguments

NameDescription
pagination
PaginationInput
filters
ProjectFilters
project
Project!

A single project by id.

Arguments

NameDescription
id
Int!
supporters
SupporterConnection!

Paginated list of the supporters of the organization. Requires the SUPPORTER_READ permission.

Arguments

NameDescription
pagination
PaginationInput
filters
SupporterFiltersInput
supporter
Supporter!

A single supporter by id. Requires the SUPPORTER_READ permission.

Arguments

NameDescription
id
Int!
supporterTags
StrConnection!

Paginated list of the labels used on supporters, for autocompletion and filtering. Requires the SUPPORTER_READ permission.

Arguments

NameDescription
pagination
PaginationInput
q
String
segments
SegmentConnection!

Paginated list of the saved segments of the organization.

Arguments

NameDescription
pagination
PaginationInput
filters
SegmentFiltersInput
segment
Segment!

A single segment by id.

Arguments

NameDescription
id
Int!
terminalLocations
[StripeTerminalLocation!]!

Locations card readers are installed at.

Arguments

NameDescription
filters
TerminalLocationFilters
terminalLocation
StripeTerminalLocation!

A single location by identifier.

Arguments

NameDescription
id
String!
terminals
[StripeTerminal!]!

Card readers paired with the organization.

terminalsByLocation
[StripeTerminal!]!

Card readers installed at the given location.

Arguments

NameDescription
locationId
String!
terminal
StripeTerminal!

A single card reader by identifier.

Arguments

NameDescription
id
String!
stripe
StripeAccount

The Stripe account connected to the organization. Null when none is connected.

stripeCustomerCards
[StripeCard!]!

Cards saved by the given Stripe customer.

Arguments

NameDescription
stripeCustomerId
String!
sumupAccount
SumUpAccount

The SumUp account connected to the organization. Null when none is connected.

redirects
RedirectConnection!

Paginated list of the redirects of the site.

Arguments

NameDescription
pagination
PaginationInput
filters
RedirectsFiltersInput
redirect
Redirect!

A single redirect by id.

Arguments

NameDescription
id
Int!
customfieldDefinitions
[CustomFieldDefinition!]!

Custom fields defined by the organization, in the order they are shown.

Arguments

NameDescription
pagination
PaginationInput
filters
CustomFieldFilters
customfieldDefinition
CustomFieldDefinition!

A single custom field definition by id.

Arguments

NameDescription
id
Int!
privacyDefinitions
PrivacyDefinitionConnection!

Paginated list of the consents the organization asks donors for.

Arguments

NameDescription
pagination
PaginationInput
filters
PrivacyDefinitionFilters
privacyDefinition
PrivacyDefinition!

A single consent definition by id.

Arguments

NameDescription
id
Int!

Article

A post published in one of the blogs of the public site.

Fields

NameDescription
id
Int!

Unique identifier of the document inside the organization.

title
String!

Title of the page, used as its heading and in listings.

content
String

Body of the page, as HTML.

visibility
WebDocumentVisibility!

Whether the page is public, reachable only by direct link, or hidden.

slug
String!

URL segment identifying the page inside the site. Unique per organization.

url
String!

Absolute URL of the page on the public site.

seoTitle
String

Title used in the <title> tag and by search engines. Falls back to title when empty.

template
String

Name of the theme template rendering the page. Empty to use the default one for this kind of document.

seoDescription
String

Meta description used by search engines and link previews.

createDate
DateTime!

When the document was created.

updateDate
DateTime!

When the document was last modified.

sitefrontUrl
String!

Absolute URL of the post on the public site.

blog
Blog!

Blog the post belongs to.

cover
Media

Cover image of the post. Null when none was set.

ArticleConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[ArticleEdge!]!

Items of this page, in the order defined by the query.

ArticleEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
Article!

The item itself.

ArticlesResponse

Result of an article mutation: the post on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

article
Article

The post as persisted after the mutation. Null when userErrors is not empty.

Blog

A blog of the public site: the page listing its posts.

Fields

NameDescription
id
Int!

Unique identifier of the document inside the organization.

title
String!

Title of the page, used as its heading and in listings.

content
String

Body of the page, as HTML.

visibility
WebDocumentVisibility!

Whether the page is public, reachable only by direct link, or hidden.

slug
String!

URL segment identifying the page inside the site. Unique per organization.

url
String!

Absolute URL of the page on the public site.

seoTitle
String

Title used in the <title> tag and by search engines. Falls back to title when empty.

template
String

Name of the theme template rendering the page. Empty to use the default one for this kind of document.

seoDescription
String

Meta description used by search engines and link previews.

createDate
DateTime!

When the document was created.

updateDate
DateTime!

When the document was last modified.

sitefrontUrl
String!

Absolute URL of the blog on the public site.

cover
Media

Cover image of the blog. Null when none was set.

BlogConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[BlogEdge!]!

Items of this page, in the order defined by the query.

BlogEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
Blog!

The item itself.

BlogsResponse

Result of a blog mutation: the blog on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

blog
Blog

The blog as persisted after the mutation. Null when userErrors is not empty.

Campaign

A fundraising campaign: the public page donors give to, together with the configuration of its donation form (amounts, frequencies, fields and payment methods).

Fields

NameDescription
id
Int!

Unique identifier of the campaign inside the organization.

title
String!

Title of the page, used as its heading and in listings.

content
String

Body of the page, as HTML.

visibility
WebDocumentVisibility!

Whether the page is public, reachable only by direct link, or hidden.

slug
String!

URL segment identifying the page inside the site. Unique per organization.

url
String!

Absolute URL of the page on the public site.

seoTitle
String

Title used in the <title> tag and by search engines. Falls back to title when empty.

template
String

Name of the theme template rendering the page. Empty to use the default one for this kind of document.

seoDescription
String

Meta description used by search engines and link previews.

createDate
DateTime!

When the campaign was created.

updateDate
DateTime!

When the campaign was last modified.

type
CampaignType!

Kind of campaign, which decides how it is presented and collected.

goal
Float

Amount the campaign aims to raise. Meaningful only when isGoalEnabled is true.

note
String

Free-text note attached by the operator. Internal, never shown on the public page.

tags
[String!]!

Free-form labels attached to the campaign, used for filtering and reporting.

allowPeerToPeer
Boolean

Whether supporters may open their own peer-to-peer fundraising page for this campaign.

isGoalEnabled
Boolean!

Whether the goal and its progress bar are shown on the public page.

costExamples
[CostExample!]!

Concrete things the donor can choose to fund, instead of giving a free amount.

excludedChannels
[Int!]!

Identifiers of the applications (channels) the campaign must not be offered on.

excludedPaymentMethods
[Int!]!

Identifiers of the payment methods that must not be offered on this campaign, even if enabled for the organization.

thankyouTemplate
String

Name of the theme template rendering the thank-you page shown after a donation. Empty to use the default one.

receiptNotificationId
Int

Identifier of the notification used to send the receipt for donations to this campaign. Null to use the default one of the organization.

hasOneOff
Boolean!

Whether the form offers one-off donations.

hasSubscription
Boolean!

Whether the form offers recurring donations.

hasSubscriptionCustomOptions
Boolean!

Whether recurring donations use their own amounts and limits instead of reusing the one-off ones.

allowCustomAmount
Boolean!

Whether the donor may type a one-off amount of their choice, on top of the suggested ones.

allowCustomSubscriptionAmount
Boolean!

Whether the donor may type a recurring amount of their choice, on top of the suggested ones.

defaultAmount
Float

One-off amount preselected on the form.

defaultSubscriptionAmount
Float

Recurring amount preselected on the form.

minAmount
Float

Smallest one-off amount accepted.

maxAmount
Float

Largest one-off amount accepted.

minSubscriptionAmount
Float

Smallest recurring amount accepted.

maxSubscriptionAmount
Float

Largest recurring amount accepted.

asks
[Float!]!

Suggested one-off amounts, shown as buttons on the form.

asksSubscription
[Float!]!

Suggested recurring amounts, shown as buttons on the form.

shownFields
[String!]!

Names of the supporter fields displayed on the donation form.

requiredFields
[String!]!

Names of the supporter fields the donor must fill in. Always a subset of shownFields.

privacyNote
String

Text shown next to the consent checkboxes on the donation form.

sitefrontUrl
String!

Absolute URL of the campaign page on the public site.

customfields
[CustomField!]!

Values of the custom fields defined by the organization for campaigns.

privacyFields
[PrivacyDefinition!]!

Privacy definitions whose consent is asked on the donation form, in the order they are shown.

cover
Media

Cover image of the campaign page. Null when none was set.

CampaignComment

A message left by a donor when giving, shown on the campaign or peer page once approved.

Fields

NameDescription
id
Int!

Unique identifier of the comment.

createDate
DateTime!

When the comment was left.

updateDate
DateTime!

When the comment was last modified or moderated.

message
String!

Text written by the donor.

status
CampaignCommentStatus!

Moderation state of the comment. Only approved comments are shown publicly.

supporter
Supporter!

Supporter who wrote the comment.

campaign
Campaign!

Campaign the comment was left on.

public
Boolean!

Whether the donor agreed to have the comment shown publicly.

anonymous
Boolean!

Whether the comment must be shown without the name of the donor.

peerCampaign
PeerCampaign

Peer page the comment was left on. Null when it was left on the campaign itself.

CampaignCommentConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[CampaignCommentEdge!]!

Items of this page, in the order defined by the query.

CampaignCommentEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
CampaignComment!

The item itself.

CampaignCommentResponse

Result of a comment mutation: the comment on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

comment
CampaignComment

The comment as persisted after the mutation. Null when userErrors is not empty.

CampaignConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[CampaignEdge!]!

Items of this page, in the order defined by the query.

CampaignEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
Campaign!

The item itself.

CampaignResponse

Result of a campaign mutation: the campaign on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

campaign
Campaign

The campaign as persisted after the mutation. Null when userErrors is not empty.

Checkout

A donation funnel session: the snapshot of what the donor entered on the form, kept under a token until the donation and the payment are created. Also used for promises, i.e. donations pledged now and paid later.

Fields

NameDescription
id
Int!

Unique identifier of the checkout inside the organization.

token
String!

Opaque token identifying the session. It is what the donation form and the payment pages address the checkout by.

state
CheckoutState!

State of the session.

errorMessage
String

Message of the last error met while completing the session, for example a refusal from the gateway. Null when nothing failed.

completedDate
DateTime

When the session was completed and turned into a donation. Null while it is still open.

supporterBusinessName
String

Legal name of the company, family or group, as entered on the form.

supporterFirstName
String

Given name entered on the form.

supporterLastName
String

Family name entered on the form.

supporterType
String

Nature of the supporter, as chosen on the form.

supporterEmail
String

Email address entered on the form.

supporterPhone
String

Landline number entered on the form.

supporterMobile
String

Mobile number entered on the form.

supporterSex
String

Gender chosen on the form.

supporterDateOfBirth
Date

Date of birth entered on the form.

supporterPlaceOfBirth
String

Place of birth entered on the form.

supporterSsn
String

National tax identifier entered on the form, needed to issue a deductible receipt.

supporterVat
String

VAT number entered on the form.

supporterAddress
String

Street address entered on the form.

supporterAddress2
String

Second address line entered on the form.

supporterCity
String

City entered on the form.

supporterLocality
String

Locality or province entered on the form.

supporterCountry
String

Country entered on the form.

supporterPostalCode
String

Postal code entered on the form.

supporterPrivacy
Boolean

Whether the donor accepted the privacy policy on the form.

supporterEmailMarketing
Boolean

Whether the donor consented to marketing by email.

supporterPhoneMarketing
Boolean

Whether the donor consented to being contacted for marketing by phone.

supporterPrivacyValues
Boolean

Whether the per-purpose consents asked by the campaign were accepted.

donationAmount
Float

Amount chosen by the donor.

donationFrequency
Frequency

Frequency chosen by the donor: a one-off gift or a recurring pledge.

costExampleQuantity
Int!

How many units of the chosen cost example the donation covers. Zero when no cost example was picked.

recoveryMailSentDate
DateTime

When the reminder for the abandoned session was sent. Null when none was sent.

applicationMetadata
JSON

Free-form JSON the application that opened the session attached to it, carried through to the donation.

tags
[String!]!

Labels to attach to the donation once the session is completed.

createDate
DateTime!

When the session was opened.

updateDate
DateTime!

When the session was last modified.

supporterFullname
String!

Display name built from the personal or business name entered on the form.

campaign
Campaign!

Campaign the session collects for.

peerCampaign
PeerCampaign

Peer-to-peer page the session was opened from. Null when it was opened on the campaign itself.

enabledPaymentMethods
[PaymentMethod!]!

Payment methods the donor may pay with, given the campaign, the channel and the chosen frequency.

supporter
Supporter

Supporter the session is attached to, when they were recognised or already created. Null otherwise.

donation
Donation

Donation created by the session. Null while it has not been completed.

checkoutUrl
String!

Absolute URL of the donation form for this session, to be sent to the donor to resume or pay it.

application
Application

Application (channel) that opened the session, such as the donation widget or a kiosk. Null when unknown.

CheckoutConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[CheckoutEdge!]!

Items of this page, in the order defined by the query.

CheckoutEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
Checkout!

The item itself.

CheckoutResponse

Result of a checkout mutation: the session on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

checkout
Checkout

The session as persisted after the mutation. Null when userErrors is not empty.

CostExample

A concrete thing a given amount pays for, offered to the donor as an alternative to a free amount (for example: 25 EUR feeds a child for a month).

Fields

NameDescription
amount
Float!

Amount that buys one unit of the example, in the currency of the organization.

name
String!

Short label of the example, shown on the donation form.

description
String!

Longer explanation of what the amount pays for.

uuid
String!

Stable identifier of the example inside the campaign.

monitorQuantity
Boolean!

Whether the available quantity is tracked and the example stops being offered once exhausted.

quantity
Int!

Total number of units offered. Meaningful only when monitorQuantity is true.

availableQuantity
Int!

Units still available. Meaningful only when monitorQuantity is true.

image
Media

Picture shown next to the example. Null when none was set.

Country

A country, as listed by the ISO 3166-1 standard.

Fields

NameDescription
name
String!

English name of the country.

code
String!

Two-letter ISO 3166-1 code of the country.

CustomField

The value of a custom field on a single record.

Fields

NameDescription
key
String!

Key of the definition the value belongs to.

type
CustomFieldType!

Type of the value, copied from the definition.

value
String

The value itself, always serialised as a string. Null when the field was left empty.

meta
CustomFieldDefinition!

The definition the value belongs to, with its label, its options and its position.

CustomFieldDefinition

A field added by the organization to one kind of record, on top of the ones Riseact provides.

Fields

NameDescription
id
Int!

Unique identifier of the definition.

entity
CustomFieldEntity!

Kind of record the field is defined on.

name
String!

Label shown to operators and donors.

key
String!

Stable key the values are written and read under. Generated from the name and never changes.

description
String

Hint shown under the field.

type
CustomFieldType!

Type of value the field holds.

position
Int!

Order the field is shown in, ascending.

options
[String!]

Values to choose from. Set only on fields of a choice type.

archived
Boolean!

Whether the field is archived. Archived fields keep their values but are no longer offered.

CustomFieldDefinitionResponse

Result of a custom field mutation: the definition on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

customFieldDefinition
CustomFieldDefinition

The definition as persisted after the mutation. Null when userErrors is not empty.

DisplayedPartner

The agency the organization is managed by, as shown in the back-office.

Fields

NameDescription
name
String!

Name of the partner.

logo
Media

Logo of the partner. Null when none was uploaded.

Donation

A donation pledge: the commitment of a supporter to give an amount, once or on a recurring schedule. The money actually collected is tracked by the related Payment records.

Fields

NameDescription
id
Int!

Unique identifier of the donation inside the organization.

code
String!

Human-readable identifier of the donation, shown in the back-office and in receipts. Empty on donations created before codes were introduced.

state
DonationState!

Lifecycle state of the pledge. Recurring pledges stay ACTIVE while they are being collected and move to PAST_DUE when a renewal fails.

amount
Float!

Amount pledged for a single instalment, in the currency of the organization. Not the total collected: use totalPaid for that.

frequency
Frequency

How often the pledge is collected. ONEOFF for a single gift, MONTHLY or ANNUALLY for a recurring one. Null when the frequency was never set.

note
String

Free-text note attached by the operator. Internal, never shown to the supporter.

completedDate
DateTime

When the pledge was fully honoured, i.e. moved to the DONE state. Null while it is still open.

createDate
DateTime!

When the donation record was created.

updateDate
DateTime!

When the donation record was last modified.

device
String

Device or channel the donation originated from. Currently always empty and kept for backward compatibility.

tags
[String!]!

Free-form labels attached to the donation, used for filtering and segmentation.

isPublic
Boolean!

Whether the donation may be shown publicly, for example in the donor wall of a peer campaign.

costExampleQuantity
Int!

How many units of the chosen costExample the donation covers. Zero when no cost example was selected.

externalRef
String

Identifier of the donation in the external system it was imported from, used to deduplicate rows on re-import. Null for donations created in Riseact.

importRun
ImportRun

The import run that created this donation, when it came from a file import. Null for donations created in Riseact.

receiptUrl
String

Signed URL of the tax receipt issued for this donation. Null when no receipt has been generated.

campaign
Campaign!

Campaign the donation was given to.

peerCampaign
PeerCampaign

Peer-to-peer fundraising page the donation came through. Null for donations collected on the campaign itself.

costExample
CostExample

Cost example the donor picked when giving, i.e. the concrete item their money funds. Null when the campaign offers none or none was chosen.

paymentMethod
PaymentMethod

Payment method used to collect the pledge. Null when no method was assigned, for example on imported or draft donations.

supporter
Supporter!

Supporter who made the pledge.

checkout
Checkout

Checkout session the donation was created from. Null for donations created in the back-office or by import.

totalPayments
Int!

Number of payments recorded against this pledge, whatever their state.

totalPaid
Float!

Sum of the payments successfully collected for this pledge, in the currency of the organization.

customfields
[CustomField!]!

Values of the custom fields defined by the organization for donations.

DonationConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[DonationEdge!]!

Items of this page, in the order defined by the query.

DonationEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
Donation!

The item itself.

DonationResponse

Result of a donation mutation: the donation on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

donation
Donation

The donation as persisted after the mutation. Null when userErrors is not empty.

ImportFailedRow

A row of the imported file that could not be processed, kept so the operator can correct it and import it again.

Fields

NameDescription
id
Int!

Unique identifier of the failed row.

rowNumber
Int!

Position of the row in the uploaded file, header excluded.

errorCode
ImportRowErrorCode!

Why the row could not be imported.

errorMessage
String

Details of the error, when the code alone is not enough.

stage
ImportStage!

Step of the import the row failed at.

rawData
JSON!

The row as read from the file, column by column.

ImportRun

One upload of a file and its processing: what it created, what it could not, and how it ended.

Fields

NameDescription
id
Int!

Unique identifier of the run.

kind
ImportKind!

What the run imports: supporters, donations or payments.

state
ImportRunState!

State of the run. Poll it to follow the progress of an upload.

filename
String

Name of the uploaded file.

rowsTotal
Int!

Number of rows read from the file.

supportersCreated
Int!

Supporters created by the run.

donationsCreated
Int!

Donations created by the run.

paymentsCreated
Int!

Payments created by the run.

rowsFailed
Int!

Rows the run could not import.

attempts
Int!

How many times the run was attempted, retries included.

fileHash
String

Digest of the uploaded file, used to recognise a file already imported.

taskId
String

Identifier of the background task processing the run.

errorCode
ImportRunError

Why the run failed as a whole. Null when it did not.

errorMessage
String

Details of the failure of the run. Null when it did not fail.

createDate
DateTime!

When the file was uploaded.

updateDate
DateTime!

When the run was last modified.

label
String!

Human-readable name of the run, built from its kind and its file.

staffName
String

Name of the staff member who uploaded the file. Null when the run was not started by a person.

failedRows
[ImportFailedRow!]!

Rows the run could not import, with the reason for each.

Media

An image uploaded by the organization, with the derived sizes used across the back-office and the public site.

Fields

NameDescription
id
Int!

Unique identifier of the media.

name
String!

File name of the uploaded image.

url
String!

URL of the image at its original size.

height
Int!

Height of the original image, in pixels.

width
Int!

Width of the original image, in pixels.

size
Int!

Weight of the original file, in bytes.

createDate
String!

When the image was uploaded, as an ISO 8601 string.

alt
String!

Alternative text of the image, for accessibility and search engines.

square
String!

URL of the square thumbnail of the image.

small
String!

URL of the small version of the image.

medium
String!

URL of the medium version of the image.

MediaConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[MediaEdge!]!

Items of this page, in the order defined by the query.

MediaEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
Media!

The item itself.

MediaResponse

Result of a media mutation: the image on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

media
Media

The image as persisted after the mutation. Null when userErrors is not empty.

A navigation menu of the public site, addressed by its handle from the theme.

Fields

NameDescription
id
Int!

Unique identifier of the menu.

name
String!

Name of the menu, shown in the back-office.

handle
String!

Stable handle the theme calls the menu by, for example main-menu.

items
[MenuItem!]!

Entries of the menu, in the order they are shown.

One entry of a navigation menu.

Fields

NameDescription
id
Int!

Unique identifier of the entry.

label
String!

Text shown in the menu.

link
String!

Address the entry points at, resolved against the site for internal destinations.

type
MenuItemType!

What the entry points at.

Result of a menu mutation: the menu on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

menu
Menu

The menu as persisted after the mutation. Null when userErrors is not empty.

Organization

The tenant: a non-profit collecting donations on Riseact, with its own data, branding, public site and billing.

Fields

NameDescription
id
Int!

Unique identifier of the organization.

reference
String!

Stable code identifying the organization across Riseact services.

name
String!

Name of the organization, shown to donors.

currency
Currencies!

Currency donations are collected in.

domain
String!

Domain the public site of the organization answers on.

contactEmail
String

Email address donors are invited to write to.

senderEmail
String

Address the notifications of the organization are sent from. Requires the DNS checks in senderEmailStatus to pass.

legalName
String

Registered name of the organization, used on receipts and invoices.

isInvoiceRequired
Boolean

Whether the organization needs an invoice for what it is billed.

vat
String

VAT number of the organization.

vatExchange
String

Code or address the electronic invoices of the organization must be delivered to.

taxIdentificationNumber
String

Tax identifier of the organization, printed on the receipts issued to donors.

contactPhone
String

Phone number donors are invited to call.

addressLine1
String

Street address of the registered office.

addressLine2
String

Second address line of the registered office.

city
String

City of the registered office.

state
String

State or province of the registered office.

postalCode
String

Postal code of the registered office.

country
Country

Country of the registered office.

tos
String

Terms of service shown on the public site and on the donation forms.

consentScopes
[String!]!

Codes of the consents the organization asks donors for by default.

privacyPolicy
String

Privacy policy shown on the public site and on the donation forms.

baseSitefrontUrl
String!

URL of the public site on the Riseact domain, which stays reachable whatever custom domain is configured.

planType
BillingPlanType

Subscription plan the organization is on. Null when it has no subscription yet.

annualCertificateAutoSend
Boolean!

Whether the yearly tax certificates are sent to supporters automatically.

annualCertificateSendMonth
Int!

Month of the year the certificates are sent in, as a number from 1 to 12.

annualCertificateSendDay
Int!

Day of the month the certificates are sent on.

annualCertificateLastSentYear
Int

Year the certificates were last sent for. Null when they were never sent.

onboardingStatus
OnboardingStatus!

How far the organization got in setting up its account.

sitefrontUrl
String!

Absolute URL of the public site, custom domain included when one is configured.

logo
Media

Logo of the organization, used on the public site and in notifications. Null when none was uploaded.

displayedPartner
DisplayedPartner

Agency managing the organization, when it is managed by one.

senderEmailStatus
OrganizationSenderEmailStatus!

Result of the DNS checks on the sender domain, with the records still to be added.

owner
User!

User owning the organization, i.e. the one billing and ownership are attached to.

jwtPassKey
String!

Short-lived token that authenticates the organization against the analytics API. Valid for 30 days.

OrganizationResponse

Result of an organization mutation: the organization on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

organization
Organization

The organization as persisted after the mutation. Null when userErrors is not empty.

OrganizationSenderEmailStatus

Result of the DNS checks on the domain the organization sends its emails from. Everything must be verified before Riseact sends on its behalf.

Fields

NameDescription
spf
Boolean!

Whether the SPF record of the sender domain is in place.

spfValue
String

SPF record to add to the DNS of the sender domain. Null once it is in place.

dkim
Boolean!

Whether the DKIM record of the sender domain is in place.

dkimValue
String

DKIM record to add to the DNS of the sender domain. Null once it is in place.

verified
Boolean!

Whether the sender address itself was verified.

verificationString
String

Record to add to the DNS to verify the sender address. Null once verified.

readyToSend
Boolean

Whether every check passed and Riseact can send email on behalf of the organization.

Page

A static page of the public site, such as who we are or how to reach us.

Fields

NameDescription
id
Int!

Unique identifier of the document inside the organization.

title
String!

Title of the page, used as its heading and in listings.

content
String

Body of the page, as HTML.

visibility
WebDocumentVisibility!

Whether the page is public, reachable only by direct link, or hidden.

slug
String!

URL segment identifying the page inside the site. Unique per organization.

url
String!

Absolute URL of the page on the public site.

seoTitle
String

Title used in the <title> tag and by search engines. Falls back to title when empty.

template
String

Name of the theme template rendering the page. Empty to use the default one for this kind of document.

seoDescription
String

Meta description used by search engines and link previews.

createDate
DateTime!

When the document was created.

updateDate
DateTime!

When the document was last modified.

sitefrontUrl
String!

Absolute URL of the page on the public site.

cover
Media

Cover image of the page. Null when none was set.

PageConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[PageEdge!]!

Items of this page, in the order defined by the query.

PageEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
Page!

The item itself.

PageInfo

State of a paginated list: whether there is more to fetch, and the cursors to fetch it with.

Fields

NameDescription
hasNextPage
Boolean!

Whether more items exist after this page.

hasPreviousPage
Boolean!

Whether more items exist before this page.

startCursor
String

Cursor of the first item of the page, to be used as before to walk backwards. Null when the page is empty.

endCursor
String

Cursor of the last item of the page, to be used as after to walk forward. Null when the page is empty.

total
Int!

Total number of items matching the query, ignoring pagination.

PagesResponse

Result of a page mutation: the page on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

page
Page

The page as persisted after the mutation. Null when userErrors is not empty.

Payment

A single movement of money against a donation: the collection of a one-off gift or of one instalment of a recurring pledge, including its refunds.

Fields

NameDescription
id
Int!

Unique identifier of the payment inside the organization.

state
PaymentState!

State of the payment. Only settled payments count towards the amount raised.

amount
Float!

Gross amount of the payment, in the currency of the organization.

paymentDate
DateTime

When the money was collected. Null while the payment has not been settled.

stripeIntentId
String
Deprecated: Deprecated on 2026-08-20, replaced by `processorTransaction { transactionId transactionIdType }`. The field only covers Stripe: it dates back to when Stripe was the only gateway, and it has no equivalent for PayPal, Satispay and SumUp. Not removed before 2027-08-20 because it is part of the public schema and is read by third-party apps.

Identifier of the Stripe payment intent that collected the money. Deprecated: use processorTransaction, which covers every gateway.

createDate
DateTime!

When the payment record was created.

updateDate
DateTime!

When the payment record was last modified.

supporter
Supporter

Supporter the money came from. Null when the payment is no longer linked to a donation.

donation
Donation

Donation the payment was collected for. Null when the donation was deleted.

paymentMethod
PaymentMethod

Method the money was collected with. Null when no method was recorded, for example on imported payments.

processorTransaction
ProcessorTransaction

Reference of the transaction on the gateway, to reconcile this payment with the records of Stripe, PayPal, Satispay or SumUp. Null for payments with no external reference.

netAmount
Float

Amount left after the fees charged by the gateway. Null when the fees are unknown or not reported by the processor.

importRun
ImportRun

The import run that created this payment, when it came from a file import. Null for payments collected by Riseact.

PaymentConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[PaymentEdge!]!

Items of this page, in the order defined by the query.

PaymentEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
Payment!

The item itself.

PaymentMethod

A way of paying offered to donors: either a gateway enabled for the organization or a manual method configured by hand, such as a bank transfer.

Fields

NameDescription
id
Int!

Unique identifier of the payment method inside the organization.

processor
PaymentProcessor!

Gateway backing the method. MANUAL for methods collected outside Riseact.

hasOneoffSupport
Boolean!

Whether the method can collect one-off donations.

hasSubscriptionSupport
Boolean!

Whether the method can collect recurring donations.

label
String

Name shown to the donor on the payment step.

description
String

Short explanation shown to the donor under the label. Set only on manual methods.

instructions
String

Instructions the donor must follow to pay, such as the bank details for a transfer. Set only on manual methods.

channels
[Int!]!

Identifiers of the applications (channels) the method is offered on. Empty means every channel.

includeInCertificate
Boolean!

Whether payments collected with this method are counted in the yearly tax certificate of the supporter.

sendInstructions
Boolean!

Whether the instructions are emailed to the donor after the donation.

PaymentMethodResponse

Result of a payment method mutation: the method on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

paymentMethod
PaymentMethod

The payment method as persisted after the mutation. Null when userErrors is not empty.

PaymentResponse

Result of a payment mutation: the payment on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

payment
Payment

The payment as persisted after the mutation. Null when userErrors is not empty.

PeerCampaign

A peer-to-peer fundraising page: a supporter collects donations for a campaign of the organization on their own page, with their own story and goal.

Fields

NameDescription
id
Int!

Unique identifier of the document inside the organization.

title
String!

Title of the page, used as its heading and in listings.

content
String

Body of the page, as HTML.

visibility
WebDocumentVisibility!

Whether the page is public, reachable only by direct link, or hidden.

slug
String!

URL segment identifying the page inside the site. Unique per organization.

url
String!

Absolute URL of the page on the public site.

seoTitle
String

Title used in the <title> tag and by search engines. Falls back to title when empty.

template
String

Name of the theme template rendering the page. Empty to use the default one for this kind of document.

seoDescription
String

Meta description used by search engines and link previews.

createDate
DateTime!

When the document was created.

updateDate
DateTime!

When the document was last modified.

supporterName
String

Name of the fundraiser as shown on the page. Falls back to the name of the supporter when empty.

customMessage
String

Personal appeal written by the fundraiser, shown on the page.

goal
Float

Amount the fundraiser aims to raise. Meaningful only when isGoalEnabled is true.

isGoalEnabled
Boolean!

Whether the goal and its progress bar are shown on the page.

thankyouTemplate
String

Name of the theme template rendering the thank-you page. Empty to use the one of the parent campaign.

receiptNotificationId
Int

Notification used to send the receipt for donations collected on this page. Null to use the one of the parent campaign.

sitefrontUrl
String!

Absolute URL of the peer page on the public site.

supporter
Supporter

Supporter who is fundraising. Null when the page is no longer linked to one.

campaign
Campaign

Campaign the page collects for. Null when the parent campaign was deleted.

PeerCampaignConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[PeerCampaignEdge!]!

Items of this page, in the order defined by the query.

PeerCampaignEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
PeerCampaign!

The item itself.

PeerCampaignResponse

Result of a peer campaign mutation: the page on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

peerCampaign
PeerCampaign

The peer page as persisted after the mutation. Null when userErrors is not empty.

PrivacyDefinition

A consent the organization asks donors for, with the text shown next to it and the marketing permissions it grants.

Fields

NameDescription
id
Int!

Unique identifier of the definition.

code
String!

Stable code the consent is recorded under on supporters.

label
String!

Short label shown next to the checkbox.

message
String

Full text of the consent, shown to the donor.

isDefault
Boolean!

Whether the consent is asked on every donation form unless the campaign says otherwise.

isRequired
Boolean!

Whether the donor must give the consent to be able to donate.

consentScopes
[String!]!

Marketing permissions the consent grants, such as email_marketing or sms_marketing. Accepting the consent sets them on the supporter.

createDate
DateTime!

When the definition was created.

updateDate
DateTime!

When the definition was last modified.

PrivacyDefinitionConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[PrivacyDefinitionEdge!]!

Items of this page, in the order defined by the query.

PrivacyDefinitionEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
PrivacyDefinition!

The item itself.

PrivacyDefinitionResponse

Result of a consent mutation: the definition on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

privacyDefinition
PrivacyDefinition

The definition as persisted after the mutation. Null when userErrors is not empty.

ProcessorTransaction

Identifier of a payment on the gateway that processed it, used to reconcile a Riseact payment with the transaction recorded by Stripe, PayPal, Satispay or SumUp.

Fields

NameDescription
processor
PaymentProcessor!

Gateway that processed the payment and therefore decides how to read transactionId.

transactionId
String

Identifier of the transaction on the payment gateway. Polymorphic: what it holds depends on the processor and is declared by transactionIdType. Null when the processor keeps no external reference (manual payments) or when none was stored for this payment.

transactionIdType
ProcessorTransactionIdType

What transactionId holds. Null whenever transactionId is null. Note for recurring PayPal donations: renewals currently resolve to PAYPAL_SUBSCRIPTION, i.e. the identifier of the subscription and not of the single renewal charge, so every renewal of the same donation reports the same value.

Project

A page that gathers several campaigns under one theme, either listed by hand or matched by rules.

Fields

NameDescription
id
Int!

Unique identifier of the project inside the organization.

title
String!

Title of the page, used as its heading and in listings.

content
String

Body of the page, as HTML.

visibility
WebDocumentVisibility!

Whether the page is public, reachable only by direct link, or hidden.

slug
String!

URL segment identifying the page inside the site. Unique per organization.

url
String!

Absolute URL of the page on the public site.

seoTitle
String

Title used in the <title> tag and by search engines. Falls back to title when empty.

template
String

Name of the theme template rendering the page. Empty to use the default one for this kind of document.

seoDescription
String

Meta description used by search engines and link previews.

createDate
DateTime!

When the document was created.

updateDate
DateTime!

When the document was last modified.

type
ProjectType!

How the campaigns are chosen: listed by hand or matched by rules.

rulesMatch
ProjectRuleMatchType!

Whether a campaign must satisfy every rule or just one of them.

campaignsOrder
ProjectCampaignsOrder!

Order the campaigns are listed in.

cover
Media

Cover image of the project page. Null when none was set.

sitefrontUrl
String!

Absolute URL of the project page on the public site.

rules
[ProjectRule!]!

Conditions campaigns must satisfy to be part of the project. Empty on projects listed by hand.

items
[ProjectCampaignItem!]!

Campaigns of the project, in the order they are listed.

ProjectCampaignItem

A campaign listed in a project, together with its position in the list.

Fields

NameDescription
id
Int!

Unique identifier of the entry.

position
Int!

Position of the campaign in the list, ascending.

campaign
Campaign!

The campaign itself.

ProjectConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[ProjectEdge!]!

Items of this page, in the order defined by the query.

ProjectEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
Project!

The item itself.

ProjectResponse

Result of a project mutation: the project on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

project
Project

The project as persisted after the mutation. Null when userErrors is not empty.

ProjectRule

One condition a campaign must satisfy to be part of a project.

Fields

NameDescription
uuid
String!

Stable identifier of the rule inside the project.

field
ProjectRuleField!

Field of the campaign the rule looks at.

operator
ProjectRuleOperator!

How the field is compared with the value.

value
String!

Value the field is compared with, always as a string.

Redirect

A redirect of the public site, used to keep old addresses working after a page is moved or renamed.

Fields

NameDescription
id
Int!

Unique identifier of the redirect.

sourcePath
String!

Path on the site that is redirected, leading slash included.

destinationUrl
String!

Address visitors are sent to.

RedirectConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[RedirectEdge!]!

Items of this page, in the order defined by the query.

RedirectEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
Redirect!

The item itself.

RedirectResponse

Result of a redirect mutation: the redirect on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

redirect
Redirect

The redirect as persisted after the mutation. Null when userErrors is not empty.

SatispayPaymentResponse

A payment opened on Satispay, as returned by their API. The donor pays it in the Satispay app and Riseact settles the donation on the webhook.

Fields

NameDescription
id
String

Identifier of the payment on Satispay.

codeIdentifier
String

Code the payment is addressed by, the one behind the QR code shown to the donor.

type
String

Kind of payment opened on Satispay.

amountUnit
Int

Amount to pay, in cents.

currency
String

Currency of the amount, as an ISO 4217 code.

status
String

State of the payment as reported by Satispay.

expired
Boolean

Whether the payment request has expired without being paid.

insertDate
String

When the payment was opened, as an ISO 8601 string.

expireDate
String

When the payment request expires, as an ISO 8601 string.

description
String

Text shown to the donor in the Satispay app.

flow
String

Satispay flow the payment was opened with.

externalCode
String

Reference Riseact attached to the payment, used to match it back to the checkout.

redirectUrl
String

URL to send the donor to in order to pay.

Segment

A saved search: a set of filters over supporters or donations, kept under a name so it can be run again.

Fields

NameDescription
id
Int!

Unique identifier of the segment.

createDate
DateTime!

When the segment was created.

updateDate
DateTime!

When the segment was last modified.

name
String!

Name of the segment, shown in the back-office.

entity
SegmentEntity!

Kind of record the segment searches over.

filters
JSON!

Filters of the segment, in the same shape as the ones taken by the search of that record.

SegmentConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[SegmentEdge!]!

Items of this page, in the order defined by the query.

SegmentEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
Segment!

The item itself.

SegmentResponse

Result of a segment mutation: the segment on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

segment
Segment

The segment as persisted after the mutation. Null when userErrors is not empty.

Staff

The membership of a person in an organization: their role, their permissions and their preferences. The account itself lives on Riseact Accounts and is shared across organizations.

Fields

NameDescription
id
Int!

Unique identifier of the membership.

userId
Int

Identifier of the account on Riseact Accounts. Null for memberships not yet linked to an account.

partnerId
Int

Identifier of the agency the member belongs to, when they are staff of a partner rather than of the organization.

name
String

Display name of the member.

email
String!

Email address the member signs in with.

state
StaffStatus!

State of the membership. Only active members can sign in.

lang
String!

Language the back-office and the notifications of the member are in.

timezone
String!

Timezone dates are shown to the member in.

createDate
String

When the membership was created, as an ISO 8601 string.

role
StaffRole!

Role of the member in the organization.

bio
String

Short description of the member, shown in the back-office.

lastLoginDate
String

When the member last signed in, as an ISO 8601 string. Null when they never did.

isOwner
Boolean!

Whether the member owns the organization. The owner cannot be removed and always keeps every permission.

permissions
[StaffPermission!]!

Permissions actually granted to the member.

StrConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[StrEdge!]!

Items of this page, in the order defined by the query.

StrEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
String!

The item itself.

StripeAccount

The Stripe account connected to the organization and what it is allowed to do.

Fields

NameDescription
accountId
String

Identifier of the connected account on Stripe. Null when none is connected.

hasOneoffSupport
Boolean!

Whether the account can collect one-off donations.

hasSubscriptionSupport
Boolean!

Whether the account can collect recurring donations.

detailsSubmitted
Boolean

Whether the organization completed the Stripe onboarding.

chargesEnabled
Boolean

Whether Stripe currently lets the account take payments.

pubKey
String!

Publishable key to use in the browser with the Stripe client library.

hasSepaEnabled
Boolean!

Whether the account can collect SEPA direct debits on top of cards.

StripeCard

A card the supporter saved on Stripe and that can be charged again.

Fields

NameDescription
id
String!

Identifier of the payment method on Stripe.

brand
StripeCardBrand!

Card network.

country
String!

Country the card was issued in, as a two-letter code.

expMonth
Int!

Expiry month of the card.

expYear
Int!

Expiry year of the card.

fingerprint
String!

Stripe fingerprint of the card, the same across saved copies of the same card.

funding
StripeCardFunding!

Whether the card is credit, debit or prepaid.

last4
String!

Last four digits of the card.

StripeCheckoutIntent

The Stripe payment intent opened for a checkout session, to be confirmed by the client.

Fields

NameDescription
clientSecret
String!

Secret the Stripe client library confirms the payment with. Never log it and never share it beyond the paying browser.

StripeCheckoutResponse

Result of opening a Stripe payment: the intent on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

checkout
StripeCheckoutIntent

The payment intent to confirm. Null when userErrors is not empty.

A short-lived link to a Stripe hosted page.

Fields

NameDescription
url
String!

URL to send the user to. It expires quickly and can be used once.

StripeTerminal

A card reader paired with the Stripe account of the organization, used to collect donations in person.

Fields

NameDescription
id
String!

Identifier of the reader on Stripe.

label
String!

Name of the reader, shown in the back-office.

serialNumber
String!

Serial number printed on the device.

status
String!

Whether the reader is currently reachable, as reported by Stripe.

locationId
String

Identifier of the location the reader is installed at.

location
StripeTerminalLocation

The location the reader is installed at. Null when it is not assigned to one.

StripeTerminalLocation

A place card readers are installed at, as recorded on Stripe.

Fields

NameDescription
id
String!

Identifier of the location on Stripe.

displayName
String!

Name of the location, shown in the back-office.

addressCity
String!

City of the location.

addressCountry
String!

Country of the location, as a two-letter code.

addressLine1
String!

Street address of the location.

addressLine2
String

Second address line of the location.

addressPostalCode
String!

Postal code of the location.

addressState
String!

State or province of the location.

terminalCount
Int!

How many card readers are installed at the location.

SumUpAccount

The SumUp account the organization collects card payments with on its own devices.

Fields

NameDescription
merchantCode
String

Code of the merchant on SumUp. Null when no account is connected.

hasPayments
Boolean!

Whether donations were already collected through this account.

Supporter

A donor or contact of the organization: personal data, contact details, marketing consents and giving history. Supporters are unique per organization.

Fields

NameDescription
id
Int!

Unique identifier of the supporter inside the organization.

archived
Boolean

Whether the supporter is archived. Archived supporters are hidden from the default lists but are never deleted.

code
String!

Human-readable identifier of the supporter, shown in the back-office.

createDate
DateTime!

When the supporter record was created.

image
String

URL of the profile picture of the supporter. Null when none was uploaded.

businessName
String

Legal name of the company, family or group. Null for private persons.

firstName
String

Given name. Null for supporters that are not private persons.

lastName
String

Family name. Null for supporters that are not private persons.

fullName
String

Display name of the supporter, computed from the personal or business name. Read-only.

supporterType
SupporterType

Nature of the supporter, which decides whether the personal or the business fields apply.

email
String

Main email address, used for receipts and notifications.

phone
String

Landline number.

mobile
String

Mobile number, used for SMS notifications.

sex
Sex

Gender recorded on the supporter.

dateOfBirth
Date

Date of birth, required by some tax receipt regimes.

placeOfBirth
String

Place of birth, required by some tax receipt regimes.

ssn
String

National tax identifier of the person (in Italy, the codice fiscale). Needed to issue a deductible receipt.

vat
String

VAT number of the company. Applies to business supporters.

title
String

Courtesy title, such as Dr. or Prof.

job
String

Job or role declared by the supporter.

address
String

Street address.

address2
String

Second address line, for care-of details or the like.

city
String

City of the address.

locality
String

Locality or province of the address.

country
String

Country of the address.

postalCode
String

Postal code of the address.

certificationUrl
String

URL of the signed acquisition document collected for the supporter, such as the consent form or the direct debit mandate. Exposed to notification templates as supporter_certificate_url.

privacy
Boolean

Whether the supporter accepted the privacy policy. The per-purpose consents are in privacyValues.

emailMarketing
Boolean

Consent to receive marketing messages by email.

phoneMarketing
Boolean

Consent to be contacted for marketing by phone.

smsMarketing
Boolean

Consent to receive marketing messages by SMS.

postalMarketing
Boolean

Consent to receive marketing material by post.

profilationMarketing
Boolean

Consent to have their data profiled for marketing purposes.

tags
[String!]!

Free-form labels attached to the supporter, used for filtering and segmentation.

note
String

Free-text note attached by the operator. Internal, never shown to the supporter.

stripeCustomerId
String

Identifier of the matching customer on Stripe, used to charge the cards saved by the supporter. Null when the supporter never paid by card.

externalRef
String

Identifier of the supporter in the external system they were imported from, unique per organization and used to deduplicate rows on re-import.

importRun
ImportRun

The import run that created this supporter, when they came from a file import. Null for supporters created in Riseact.

customfields
[CustomField!]!

Values of the custom fields defined by the organization for supporters.

privacyValues
[SupporterPrivacyValue!]!

Consents given by the supporter, one entry per privacy definition of the organization.

sourceCampaign
Campaign

Campaign the supporter was acquired through. Null when the origin is unknown.

sourcePeerCampaign
PeerCampaign

Peer-to-peer page the supporter was acquired through. Null when they did not come from one.

totalDonations
Int!

Number of donation pledges made by the supporter.

totalDonated
String!

Total amount actually collected from the supporter, as a decimal string.

averageDonation
String!

Average amount collected per donation, as a decimal string.

lastOneoffDonation
Donation

Most recent one-off donation of the supporter. Null when they never gave a one-off gift.

activeRegularDonations
[Donation!]!

Recurring pledges of the supporter that are still being collected.

savedCards
[StripeCard!]!

Cards the supporter saved on Stripe and that can be charged again.

SupporterConnection

A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.

Fields

NameDescription
pageInfo
PageInfo!

State of the pagination for this page.

edges
[SupporterEdge!]!

Items of this page, in the order defined by the query.

SupporterEdge

One item of a paginated list, together with the cursor that points at it.

Fields

NameDescription
cursor
String!

Opaque cursor of this item, to be passed as after or before to fetch the neighbouring page.

node
Supporter!

The item itself.

SupporterPrivacyValue

A consent recorded on a supporter, resolved against the privacy definitions of the organization.

Fields

NameDescription
code
String!

Code of the privacy definition the consent refers to.

label
String!

Human-readable label of the privacy definition.

value
Boolean!

Whether the consent was given.

date
DateTime

When the consent was collected. Null for consents recorded without a date.

SupporterResponse

Result of a supporter mutation: the supporter on success, or the validation errors that prevented it.

Fields

NameDescription
userErrors
[UserError!]

Validation errors that prevented the operation. Null or empty when the mutation succeeded.

supporter
Supporter

The supporter as persisted after the mutation. Null when userErrors is not empty.

User

A person with an account on Riseact Accounts, identified by their email address.

Fields

NameDescription
id
Int!

Unique identifier of the user.

email
String!

Email address the user signs in with.

name
String

Display name of the user.

verificationToken
String

Token to verify the email address of the user. Null once the address is verified.

UserError

A single validation error that prevented a mutation from completing. Reported to the caller instead of raising, so the client can show it next to the offending field.

Fields

NameDescription
code
ErrorCode!

Machine-readable classification of the error.

field
String

Name of the input field the error refers to, when it can be attributed to one. Null for errors about the operation as a whole.

message
String

Human-readable message, already translated into the language of the request.