# infoodle API ## Description This is version `2.1.0` of this API documentation. Last update on Jul 28, 2025. This API gives access to your infoodle site. It uses the OAuth2.0 protocol to access any personal content. When authenticating, you will be using an infoodle user account's details. This user therefore needs access to the people, groups, workflow etc that you are expecting to have access through this API. For example, if you want to search for a specific person - the credentials you are using **must** be associated with a user who has the correct role and permissions to find that person. You can check this by logging into the infoodle site and trying the test api. Rate Limit: This API has the following rate limits: - 500 requests within 5 minutes - 2000 requests within 1 hour Exceeding this limits will generate a response code of 429 Too many requests. ## Servers - API Auto Mocking: https://YOURSITE.infoodle.com/apiv2 (API Auto Mocking) ## Authentication ## Endpoints and operations ### [Accountcode](https://api.infoodle.com/group/endpoint-accountcode.md) - [Add a new account code](https://api.infoodle.com/operation/operation-post-accountcode.md) - [Get a specific account code](https://api.infoodle.com/operation/operation-get-accountcode-parameter.md) - [Update a specific account code](https://api.infoodle.com/operation/operation-patch-accountcode-parameter.md) - [List a page of account codes where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-accountcode-list-parameter.md) - [Check for any items that are after fromthisid](https://api.infoodle.com/operation/operation-get-accountcode-poll-parameter-parameter.md) - [Search account codes](https://api.infoodle.com/operation/operation-post-accountcode-search-parameter.md) ### [Bankaccount](https://api.infoodle.com/group/endpoint-bankaccount.md) - [Add a new bank account](https://api.infoodle.com/operation/operation-post-bankaccount.md) - [Get a specific bank account](https://api.infoodle.com/operation/operation-get-bankaccount-parameter.md) - [Update a specific bankaccount](https://api.infoodle.com/operation/operation-patch-bankaccount-parameter.md) - [List a page of bank accounts where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-bankaccount-list-parameter.md) - [Check for any items that are after fromthisid](https://api.infoodle.com/operation/operation-get-bankaccount-poll-parameter-parameter.md) - [Search bank accounts](https://api.infoodle.com/operation/operation-post-bankaccount-search-parameter.md) ### [Batch](https://api.infoodle.com/group/endpoint-batch.md) - [Add a new batch for transactions](https://api.infoodle.com/operation/operation-post-batch.md) - [Get a specific batch for transactions](https://api.infoodle.com/operation/operation-get-batch-parameter.md) - [Update a specific batch](https://api.infoodle.com/operation/operation-patch-batch-parameter.md) - [List a page of batch where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-batch-list-parameter.md) - [Check for any items that are after fromthisid](https://api.infoodle.com/operation/operation-get-batch-poll-parameter-parameter.md) - [Search trasaction batches](https://api.infoodle.com/operation/operation-post-batch-search-parameter.md) ### [Campaign](https://api.infoodle.com/group/endpoint-campaign.md) - [Add a new campaign](https://api.infoodle.com/operation/operation-post-campaign.md) - [Get a specific campaign](https://api.infoodle.com/operation/operation-get-campaign-parameter.md) - [Update a specific campaign](https://api.infoodle.com/operation/operation-patch-campaign-parameter.md) - [List a page of campaigns where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-campaign-list-parameter.md) - [Check for any items that are after fromthisid](https://api.infoodle.com/operation/operation-get-campaign-poll-parameter-parameter.md) - [Search campaigns](https://api.infoodle.com/operation/operation-post-campaign-search-parameter.md) ### [Campaigntype](https://api.infoodle.com/group/endpoint-campaigntype.md) - [Add a new campaign type](https://api.infoodle.com/operation/operation-post-campaigntype.md) - [Get a specific campaign type](https://api.infoodle.com/operation/operation-get-campaigntype-parameter.md) - [Update a specific campaign type](https://api.infoodle.com/operation/operation-patch-campaigntype-parameter.md) - [List a page of campaign types where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-campaigntype-list-parameter.md) - [Check for any items that are after fromthisid](https://api.infoodle.com/operation/operation-get-campaigntype-poll-parameter-parameter.md) - [Search campaign login_types](https://api.infoodle.com/operation/operation-post-campaigntype-search-parameter.md) ### [Country](https://api.infoodle.com/group/endpoint-country.md) - [Get a specific country](https://api.infoodle.com/operation/operation-get-country-parameter.md) - [List Countries](https://api.infoodle.com/operation/operation-get-country-list.md) ### [Customfield](https://api.infoodle.com/group/endpoint-customfield.md) - [Get a specific custom field](https://api.infoodle.com/operation/operation-get-customfield-parameter.md) - [List custom fields](https://api.infoodle.com/operation/operation-get-customfield-list.md) ### [Events](https://api.infoodle.com/group/endpoint-events.md) - [Return a list of events](https://api.infoodle.com/operation/operation-get-events-bydate-parameter-parameter-parameter.md) - [Return a list of events](https://api.infoodle.com/operation/operation-get-events-bydate-parameter-parameter-ids-parameter.md) - [Return a specific event](https://api.infoodle.com/operation/operation-get-events-event-parameter-parameter.md) - [Return a specific event, and the household members of logged in person](https://api.infoodle.com/operation/operation-get-events-myfamily-parameter-parameter.md) ### [Financedefaults](https://api.infoodle.com/group/endpoint-financedefaults.md) - [Return a list of available finance defaults](https://api.infoodle.com/operation/operation-get-financedefaults-list.md) - [Return a list of available finance defaults](https://api.infoodle.com/operation/operation-get-financedefaults-parameter.md) - [Update a specific finance default](https://api.infoodle.com/operation/operation-post-financedefaults-parameter.md) ### [Form](https://api.infoodle.com/group/endpoint-form.md) - [Get a specific form by ID](https://api.infoodle.com/operation/operation-get-form-parameter.md) - [Return a list of forms this user can access](https://api.infoodle.com/operation/operation-get-form-list.md) ### [Formentries](https://api.infoodle.com/group/endpoint-formentries.md) - [Get a specific form entry by ID](https://api.infoodle.com/operation/operation-get-formentries-parameter.md) - [List a page of form entries where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-formentries-list-parameter.md) - [Search form entries with filtering criteria](https://api.infoodle.com/operation/operation-post-formentries-search-parameter.md) - [Poll for new form entries](https://api.infoodle.com/operation/operation-get-formentries-poll-parameter-parameter.md) ### [Formentryfields](https://api.infoodle.com/group/endpoint-formentryfields.md) - [Get form entry fields by form entry ID](https://api.infoodle.com/operation/operation-get-formentryfields-parameter.md) ### [Global](https://api.infoodle.com/group/endpoint-global.md) - [Get some details from logged in user](https://api.infoodle.com/operation/operation-get-global-mysettings.md) - [Check site is available](https://api.infoodle.com/operation/operation-get-global-ping.md) - [Retrieve the configuration of the site](https://api.infoodle.com/operation/operation-get-global-site.md) - [Get some stats](https://api.infoodle.com/operation/operation-get-global-statistics-parameter-parameter.md) ### [Group](https://api.infoodle.com/group/endpoint-group.md) - [Add a new group](https://api.infoodle.com/operation/operation-post-group.md) - [Add or update the membership of a user to the group](https://api.infoodle.com/operation/operation-post-group-parameter-parameter.md) ### [Groups](https://api.infoodle.com/group/endpoint-groups.md) - [Record a check in or check out of group/non group members](https://api.infoodle.com/operation/operation-get-groups-attendance-parameter-parameter-parameter.md) - [Generate a list of groups. Include any child groups as a part of the list](https://api.infoodle.com/operation/operation-get-groups-flatlist-parameter-parameter.md) - [Generate a list of groups. Include any child groups as nested arrays of child groups](https://api.infoodle.com/operation/operation-get-groups-list-parameter-parameter.md) - [List members in a group](https://api.infoodle.com/operation/operation-get-groups-members-parameter-parameter.md) - [Generate a list of all the members in the group specified and the state of their registration at the event on a specific date](https://api.infoodle.com/operation/operation-get-groups-membersforevent-parameter-parameter-parameter-parameter.md) ### [Grouptypes](https://api.infoodle.com/group/endpoint-grouptypes.md) - [List available group types](https://api.infoodle.com/operation/operation-get-grouptypes-list.md) ### [Library](https://api.infoodle.com/group/endpoint-library.md) - [The list of collections in the catalogue](https://api.infoodle.com/operation/operation-get-library-parameter-parameter-list.md) - [The list of catalogues in the library](https://api.infoodle.com/operation/operation-get-library-parameter-list.md) - [Return the details for a specific item](https://api.infoodle.com/operation/operation-get-library-item-parameter.md) - [The list of available libraries](https://api.infoodle.com/operation/operation-get-library-list.md) - [Reserve items](https://api.infoodle.com/operation/operation-post-library-reserveitems.md) - [Search the library anywhere by different methods](https://api.infoodle.com/operation/operation-get-library-search-parameter-parameter-parameter-parameter.md) ### [Location](https://api.infoodle.com/group/endpoint-location.md) - [List available locations](https://api.infoodle.com/operation/operation-get-location-list.md) - [Add a new location](https://api.infoodle.com/operation/operation-post-location.md) - [Get a specific location](https://api.infoodle.com/operation/operation-get-location-parameter.md) - [Update a specific location](https://api.infoodle.com/operation/operation-patch-location-parameter.md) - [List a page of locations where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-location-list-parameter.md) - [Check for any items that are after fromthisid](https://api.infoodle.com/operation/operation-get-location-poll-parameter-parameter.md) - [Search for locations](https://api.infoodle.com/operation/operation-post-location-search-parameter.md) ### [Lookuplist](https://api.infoodle.com/group/endpoint-lookuplist.md) - [Get a single lookuplist](https://api.infoodle.com/operation/operation-get-lookuplist-parameter.md) - [List Lookup List](https://api.infoodle.com/operation/operation-get-lookuplist-list.md) ### [Messaging](https://api.infoodle.com/group/endpoint-messaging.md) - [Return a list of notification topics](https://api.infoodle.com/operation/operation-get-messaging-topics-list.md) ### [Notes](https://api.infoodle.com/group/endpoint-notes.md) - [Add a new note](https://api.infoodle.com/operation/operation-post-notes.md) - [Delete the specific note](https://api.infoodle.com/operation/operation-delete-notes-parameter.md) - [Update a specific note (put is depricated)](https://api.infoodle.com/operation/operation-patch-notes-parameter.md) - [Return a list of notes this user can access](https://api.infoodle.com/operation/operation-get-notes-list-parameter.md) - [Get the lists you need when creating notes](https://api.infoodle.com/operation/operation-get-notes-settings.md) ### [Occupation](https://api.infoodle.com/group/endpoint-occupation.md) - [Get all Occupations](https://api.infoodle.com/operation/operation-get-occupation-list.md) ### [People](https://api.infoodle.com/group/endpoint-people.md) - [Add person](https://api.infoodle.com/operation/operation-post-people.md) - [edit a person](https://api.infoodle.com/operation/operation-patch-people-parameter.md) - [Search the database people matching the query. Return a summary list of key data suitable for a directory view.](https://api.infoodle.com/operation/operation-get-people-directorysearch-parameter-parameter.md) - [Get details about a single contact record](https://api.infoodle.com/operation/operation-get-people-item-parameter.md) - [Get a list of people and their data since the last poll](https://api.infoodle.com/operation/operation-get-people-poll_new.md) - [Search the database people matching the query](https://api.infoodle.com/operation/operation-get-people-search-parameter-parameter-parameter.md) ### [Pledge](https://api.infoodle.com/group/endpoint-pledge.md) - [Add a new pledge](https://api.infoodle.com/operation/operation-post-pledge.md) - [Get a specific pledge](https://api.infoodle.com/operation/operation-get-pledge-parameter.md) - [Update a specific pledge](https://api.infoodle.com/operation/operation-patch-pledge-parameter.md) - [List a page of pledges where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-pledge-list-parameter.md) - [Check for any items that are after fromthisid](https://api.infoodle.com/operation/operation-get-pledge-poll-parameter-parameter.md) - [Search for pledges](https://api.infoodle.com/operation/operation-post-pledge-search-parameter.md) ### [Pledgedate](https://api.infoodle.com/group/endpoint-pledgedate.md) - [Add a new pledge date to a pledge](https://api.infoodle.com/operation/operation-post-pledgedate.md) - [Get a specific pledge date](https://api.infoodle.com/operation/operation-get-pledgedate-parameter.md) - [Update a specific pledge date](https://api.infoodle.com/operation/operation-patch-pledgedate-parameter.md) - [List a page of pledge dates where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-pledgedate-list-parameter.md) - [Check for any items that are after fromthisid](https://api.infoodle.com/operation/operation-get-pledgedate-poll-parameter-parameter.md) - [Search for pledge date](https://api.infoodle.com/operation/operation-post-pledgedate-search-parameter.md) ### [Pledgedrive](https://api.infoodle.com/group/endpoint-pledgedrive.md) - [Add a new pledge drive](https://api.infoodle.com/operation/operation-post-pledgedrive.md) - [Get a specific pledge drive](https://api.infoodle.com/operation/operation-get-pledgedrive-parameter.md) - [Update a specific pledgedrive](https://api.infoodle.com/operation/operation-patch-pledgedrive-parameter.md) - [List a page of pledge drives where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-pledgedrive-list-parameter.md) - [Check for any items that are after fromthisid](https://api.infoodle.com/operation/operation-get-pledgedrive-poll-parameter-parameter.md) - [Search pledge drives](https://api.infoodle.com/operation/operation-post-pledgedrive-search-parameter.md) ### [Roles](https://api.infoodle.com/group/endpoint-roles.md) - [List all roles](https://api.infoodle.com/operation/operation-get-roles-list.md) ### [Rosters](https://api.infoodle.com/group/endpoint-rosters.md) - [Used to authorise a user with a one time pincode](https://api.infoodle.com/operation/operation-get-rosters-pincode.md) ### [Stock](https://api.infoodle.com/group/endpoint-stock.md) - [Add a new stock item](https://api.infoodle.com/operation/operation-post-stock.md) - [Get a specific stock item](https://api.infoodle.com/operation/operation-get-stock-parameter.md) - [Update a specific stock item](https://api.infoodle.com/operation/operation-patch-stock-parameter.md) - [List a page of stock items where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-stock-list-parameter.md) - [Check for any items that are after fromthisid](https://api.infoodle.com/operation/operation-get-stock-poll-parameter-parameter.md) - [Search stock items](https://api.infoodle.com/operation/operation-post-stock-search-parameter.md) ### [Tagheaders](https://api.infoodle.com/group/endpoint-tagheaders.md) - [Add a new tag header](https://api.infoodle.com/operation/operation-post-tagheaders.md) - [Get a specific tag header](https://api.infoodle.com/operation/operation-get-tagheaders-parameter.md) - [Update a specific tag header](https://api.infoodle.com/operation/operation-patch-tagheaders-parameter.md) - [List a page of tag headers where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-tagheaders-list-parameter.md) - [Check for any items that are after fromthisid](https://api.infoodle.com/operation/operation-get-tagheaders-poll-parameter-parameter.md) - [Search tag headers](https://api.infoodle.com/operation/operation-post-tagheaders-search-parameter.md) ### [Tagrelation](https://api.infoodle.com/group/endpoint-tagrelation.md) - [Add a new tag relation](https://api.infoodle.com/operation/operation-post-tagrelation.md) - [Remove tags from a specific item](https://api.infoodle.com/operation/operation-patch-tagrelation-parameter.md) ### [Tags](https://api.infoodle.com/group/endpoint-tags.md) - [Add a new tag](https://api.infoodle.com/operation/operation-post-tags.md) - [Get a specific tag](https://api.infoodle.com/operation/operation-get-tags-parameter.md) - [Update a specific tag](https://api.infoodle.com/operation/operation-patch-tags-parameter.md) - [List a page of tags where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-tags-list-parameter.md) - [Check for any items that are after fromthisid](https://api.infoodle.com/operation/operation-get-tags-poll-parameter-parameter.md) - [Search tag](https://api.infoodle.com/operation/operation-post-tags-search-parameter.md) ### [Todo](https://api.infoodle.com/group/endpoint-todo.md) - [Complete an existing todo](https://api.infoodle.com/operation/operation-post-todo-complete-parameter-parameter.md) - [Retrieve a page of todo's for a contact](https://api.infoodle.com/operation/operation-get-todo-profile-parameter-parameter-parameter.md) - [Retrieve a page of todo's for the current logged in user to do](https://api.infoodle.com/operation/operation-get-todo-user-todo-parameter.md) ### [Transaction](https://api.infoodle.com/group/endpoint-transaction.md) - [Add a new transaction](https://api.infoodle.com/operation/operation-post-transaction.md) - [Get a specific transaction](https://api.infoodle.com/operation/operation-get-transaction-parameter.md) - [Update a specific transaction](https://api.infoodle.com/operation/operation-patch-transaction-parameter.md) - [List a page of transactions where the ID is greater than the optionally supplied fromthisid parameter](https://api.infoodle.com/operation/operation-get-transaction-list-parameter.md) - [Check for any items that are after fromthisid](https://api.infoodle.com/operation/operation-get-transaction-poll-parameter-parameter.md) - [Search transactions](https://api.infoodle.com/operation/operation-post-transaction-search-parameter.md) ### [Workqueues](https://api.infoodle.com/group/endpoint-workqueues.md) - [Used to get a list of potential queues to add people to](https://api.infoodle.com/operation/operation-get-workqueues-parameter.md) - [Add a person to a workqueue/workflow](https://api.infoodle.com/operation/operation-get-workqueues-addperson.md) [Powered by Bump.sh](https://bump.sh)