ESC
Example searches: “accountcode”, “Accountcode”, “content_enabled”, “giftaid”, “errorfield”
Search…
Ctrl+K
⌘K
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Toggle dark mode
infoodle
Topics
Introduction
Authentication
Endpoints
Accountcode
Add a new account code
POST
Get a specific account code
GET
Update a specific account code
PATCH
List a page of account codes where the ID is greater than the optionally supplied fromthisid parameter
GET
Check for any items that are after fromthisid
GET
Search account codes
POST
Bankaccount
Add a new bank account
POST
Get a specific bank account
GET
Update a specific bankaccount
PATCH
List a page of bank accounts where the ID is greater than the optionally supplied fromthisid parameter
GET
Check for any items that are after fromthisid
GET
Search bank accounts
POST
Batch
Add a new batch for transactions
POST
Get a specific batch for transactions
GET
Update a specific batch
PATCH
List a page of batch where the ID is greater than the optionally supplied fromthisid parameter
GET
Check for any items that are after fromthisid
GET
Search trasaction batches
POST
Campaign
Add a new campaign
POST
Get a specific campaign
GET
Update a specific campaign
PATCH
List a page of campaigns where the ID is greater than the optionally supplied fromthisid parameter
GET
Check for any items that are after fromthisid
GET
Search campaigns
POST
Campaigntype
Add a new campaign type
POST
Get a specific campaign type
GET
Update a specific campaign type
PATCH
List a page of campaign types where the ID is greater than the optionally supplied fromthisid parameter
GET
Check for any items that are after fromthisid
GET
Search campaign login_types
POST
Country
Get a specific country
GET
List Countries
GET
Customfield
Get a specific custom field
GET
List custom fields
GET
Events
Return a list of events
GET
Return a list of events
GET
Return a specific event
GET
Return a specific event, and the household members of logged in person
GET
Financedefaults
Return a list of available finance defaults
GET
Return a list of available finance defaults
GET
Update a specific finance default
POST
Form
Get a specific form by ID
GET
Return a list of forms this user can access
GET
Formentries
Get a specific form entry by ID
GET
List a page of form entries where the ID is greater than the optionally supplied fromthisid parameter
GET
Search form entries with filtering criteria
POST
Poll for new form entries
GET
Formentryfields
Get form entry fields by form entry ID
GET
Global
Get some details from logged in user
GET
Check site is available
GET
Retrieve the configuration of the site
GET
Get some stats
GET
Group
Add a new group
POST
Add or update the membership of a user to the group
POST
Groups
Record a check in or check out of group/non group members
GET
Generate a list of groups. Include any child groups as a part of the list
GET
Generate a list of groups. Include any child groups as nested arrays of child groups
GET
List members in a group
GET
Generate a list of all the members in the group specified and the state of their registration at the event on a specific date
GET
Grouptypes
List available group types
GET
Library
The list of collections in the catalogue
GET
The list of catalogues in the library
GET
Return the details for a specific item
GET
The list of available libraries
GET
Reserve items
POST
Search the library anywhere by different methods
GET
Location
List available locations
GET
Add a new location
POST
Get a specific location
GET
Update a specific location
PATCH
List a page of locations where the ID is greater than the optionally supplied fromthisid parameter
GET
Check for any items that are after fromthisid
GET
Search for locations
POST
Lookuplist
Get a single lookuplist
GET
List Lookup List
GET
Messaging
Return a list of notification topics
GET
Notes
Add a new note
POST
Delete the specific note
DELETE
Update a specific note (put is depricated)
PATCH
Return a list of notes this user can access
GET
Get the lists you need when creating notes
GET
Occupation
Get all Occupations
GET
People
Add person
POST
Edit a person
PATCH
Search the database people matching the query. Return a summary list of key data suitable for a directory view.
GET
Get details about a single contact record
GET
Get a list of people and their data since the last poll
GET
Search the database people matching the query
GET
Pledge
Add a new pledge
POST
Get a specific pledge
GET
Update a specific pledge
PATCH
List a page of pledges where the ID is greater than the optionally supplied fromthisid parameter
GET
Check for any items that are after fromthisid
GET
Search for pledges
POST
Pledgedate
Add a new pledge date to a pledge
POST
Get a specific pledge date
GET
Update a specific pledge date
PATCH
List a page of pledge dates where the ID is greater than the optionally supplied fromthisid parameter
GET
Check for any items that are after fromthisid
GET
Search for pledge date
POST
Pledgedrive
Add a new pledge drive
POST
Get a specific pledge drive
GET
Update a specific pledgedrive
PATCH
List a page of pledge drives where the ID is greater than the optionally supplied fromthisid parameter
GET
Check for any items that are after fromthisid
GET
Search pledge drives
POST
Roles
List all roles
GET
Rosters
Used to authorise a user with a one time pincode
GET
Stock
Add a new stock item
POST
Get a specific stock item
GET
Update a specific stock item
PATCH
List a page of stock items where the ID is greater than the optionally supplied fromthisid parameter
GET
Check for any items that are after fromthisid
GET
Search stock items
POST
Tagheaders
Add a new tag header
POST
Get a specific tag header
GET
Update a specific tag header
PATCH
List a page of tag headers where the ID is greater than the optionally supplied fromthisid parameter
GET
Check for any items that are after fromthisid
GET
Search tag headers
POST
Tagrelation
Add a new tag relation
POST
Remove tags from a specific item
PATCH
Tags
Add a new tag
POST
Get a specific tag
GET
Update a specific tag
PATCH
List a page of tags where the ID is greater than the optionally supplied fromthisid parameter
GET
Check for any items that are after fromthisid
GET
Search tag
POST
Todo
Complete an existing todo
POST
Retrieve a page of todo's for a contact
GET
Retrieve a page of todo's for the current logged in user to do
GET
Transaction
Add a new transaction
POST
Get a specific transaction
GET
Update a specific transaction
PATCH
List a page of transactions where the ID is greater than the optionally supplied fromthisid parameter
GET
Check for any items that are after fromthisid
GET
Search transactions
POST
Workqueues
Used to get a list of potential queues to add people to
GET
Add a person to a workqueue/workflow
GET
Search…
Ctrl+K
⌘K
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Toggle dark mode
infoodle
Dismiss highlight
Show more
Formentryfields