Qodex.ai
Qodex.ai
Introduction
Reference
Account and Permissions-Authentication Token
Get Token
Account and Permissions-Organization
Get the Organizations the current user belongs toGet the Current Organization for the current userSwitch the Current Organization
Account and Permissions-Permission
Get Permissions for the current user
Contacts and Individuals-Contacts-How to Get Contacts
Get a ContactGet a Contact by Reference Source and IDGet a Contact by Reference IDGet Contacts by Tag IDFind a Contact by Email Address or Reference Source and IDFind all Contacts that match, fully or partially, the given search parametersFind all Contacts within a given proximity of a geocoordinateGet the Activity for the Contacts the current user is followingGet the Contacts the current user is following
Contacts and Individuals-Contacts-How to Create and Update Contacts
Create a ContactUpdate a ContactArchive a ContactUnarchive a ContactFollow or Unfollow a Contact for the current user
Contacts and Individuals-Contacts-Working with Collections
Get Custom Collections for ContactsCreate Collection for a ContactUpdate Collection for a ContactDelete Collection for a Contact
Contacts and Individuals-Contacts-Contact Imports
Create a Contact that will go through the import processCreate a Contact Import that will be processed for changes and duplicates
Contacts and Individuals-Contacts-Configuration
Get Contact Name Prefixes and TitlesGet Contact TypesGet Contact Custom Fields Available
Contacts and Individuals-Contacts-Contact Queries
Get Contact Query OptionsQuery Contacts with Abbreviated DetailsQuery Contacts with Full Details
Contacts and Individuals-Contacts-Receipts
ReceiptsGet Receipt
Contacts and Individuals-Individuals-How to Get Individuals
Get Individuals for a ContactGet an IndividualFind an individual by email addressGets the avatar for a specified contact individual
Contacts and Individuals-Individuals-How to Create and Update
Create an IndividualUpload the avatar for an IndividualUpdate an IndividualDelete an Individual
Contacts and Individuals-Individuals-Working with Collections
Get Custom Collections for IndividualsCreate Collection for an IndividualUpdate Collection for an IndividualDelete Collection for an Individual
Contacts and Individuals-Individuals-Configuration
Gets the custom fields for contact individuals
Contacts and Individuals-Individuals-Individual Queries
Get Individual Query OptionsQuery Individuals
Contacts and Individuals-Individuals-Email Lists
Get Email Lists for an Individual
Contacts and Individuals-Contact Addresses
Get the Contact Addresses for a ContactGet a Contact AddressCreate a Contact AddressUpdate a Contact AddressArchive a Contact AddressUnarchive a Contact AddressDelete a Contact Address
Contacts and Individuals-Contact Methods
Get Contact Method TypesGet Contact Methods Types related to the Base TypeGet a Contact MethodCreate a Contact Method for an IndividualUpdate a Contact MethodArchive a Contact MethodUnarchive a Contact MethodDelete a Contact Method
Contacts and Individuals-Contact Notes
Get the Notes for a ContactGet the Important Notes for a ContactGet a NoteCreate a Note for a ContactCreate a Note using an EmailUpdate a NoteDelete a NoteGet Contact Note Query OptionsQuery Contact NotesGet Contact Note TypesGets the custom fields for contact note
Contacts and Individuals-Contact References
Create a Contact ReferenceDelete a Contact Reference
Contacts and Individuals-Tags
Get all TagsFind all Tags that match, fully or partially
Contacts and Individuals-Contact Tags
Get Tags for a ContactCreate a Contact TagDelete a Contact Tag
Contacts and Individuals-Organization Groups
Get all Organization GroupsGet Organization Groups for a ContactGet the Contacts in an Organization GroupGet an Organization GroupAssign a Contact to an Organization GroupRemove a Contact from an Organization Group
Contacts and Individuals-Relationships
Get Relationships for a ContactCreate a RelationshipUpdate a RelationshipDelete a RelationshipGet Relationship Types
Contacts and Individuals-Tributes
Search for TributesCreate a TributeUpdate a Tribute
Giving-Gifts-How to Get Gifts
Get Gifts for a ContactGet Gifts for a Contact by Reference IDGet Passthrough Gifts for a ContactGet a GiftGet a Gift by Transaction Source and ID
Giving-Gifts-How to Create and Update Gifts
Create a Gift *not recommended*Create many Gifts *not recommended*Create a Reversing TransactionUpdate a GiftUpdate many GiftsDelete a Gift
Giving-Gifts-Gift Imports
Create a Gift TransactionCreate a Batch of Gift Transactions
Giving-Gifts-Configuration
Get Gift Custom Fields AvailableGet Non-Cash Gift Types Available
Giving-Gifts-Gift Queries
Get Gift Query OptionsQuery Gifts with Abbreviated DetailsQuery Gifts with Full Details
Giving-Gift Designations
Get Gift Designation Query OptionsQuery Gift Designations
Giving-Gift Asks
Get Gift Asks for a ContactGet the Gifts applied to a Gift AskGet a Gift AskCreate a Gift AskUpdate a Gift AskGet Gift Ask Custom Fields AvailableGet Gift Ask Query OptionsQuery Gift Asks
Giving-Planned Gifts
Get Planned Gifts for a ContactGet Planned GiftGet Gifts Applied to a Planned GiftCreate a Planned GiftUpdate a Planned GiftGet Planned Gift Custom Fields AvailableGet Planned Gift Query OptionsQuery Planned Gifts
Giving-Pledges
Get Pledges for a ContactGet PledgeCreate a PledgeUpdate a PledgeWrite-off the PledgeGet Pledge Custom Fields AvailableGet Pledge Query OptionsQuery Pledges
Giving-Premiums
Get PremiumGet Premium using a unique CodeFind PremiumsCreate a PremiumUpdate a PremiumIncrement the inventory countDecrement the inventory countGet Premium Custom Fields AvailableQuery PremiumsGet Premium Query Options
Giving-Recurring Gifts
Get Recurring Gifts for a ContactGet a Recurring GiftCreate a Recurring GiftUpdate a Recurring GiftCancel a Recurring GiftGet Recurring Gift Custom Fields AvailableGet Recurring Gift Query OptionsQuery Recurring Gifts
Giving-Recurring Gift Payments
Get Payments for a Recurring Gift
Campaigns-Campaigns
Get CampaignGets Campaign StepsGet Campaign Query OptionsQuery Campaigns
Campaigns-Communications
Get Communications for a CampaignGet CommunicationGet Channel TypesGet Communication TypesCreate CommunicationQuery CommunicationsCommunication Query Options
Campaigns-Segments
Get the Segments for a ContactGet a SegmentGet a Segment using a unique CodeFind SegmentsCreate a SegmentUpdate a Segment
Projects-How to Get Projects
Get ProjectGet a Project using a unique CodeFind Projects
Projects-How to Create and Update Projects
Create a ProjectUpdate a ProjectUpdate many ProjectsTemporarily Change Project Inventory StatusUpdate Project Balance
Projects-Configuration
Get Project Custom Fields AvailableGet Project Types
Projects-Project Queries
Get Project Query OptionsQuery Projects
Projects-Project Expenses
Get Project Expenses for a ProjectGet Project ExpenseCreate a Project ExpenseCreate many Project ExpensesUpdate a Project Expense
Projects-Project Notes
Get Notes for a ProjectGet Project NoteCreate a Project NoteUpdate a Project NoteDelete a Project NoteGet Project Note Types
Projects-Project Roles
Get Project Roles for a ContactGet Project Roles for a ProjectGet Project RoleCreate a Project RoleUpdate a Project RoleDelete a Project RoleGet Project Role Types
Events-Event
Get EventsGet an EventFind an EventCreate an EventUpdate an EventDelete an EventGet the Event TypesGet Event Custom Fields AvailableGet Event Query OptionsQuery Events
Events-Event Attendees
Get Event Attendees for an EventGet an Event AttendeeCreate an Event AttendeeUpdate an Event AttendeeDelete an Event AttendeeGet Event Attendee Custom Fields AvailableGet Event Attendee Query OptionsQuery Event Attendees
Events-Event Contacts
Get Event Contacts for an EventGet an Event ContactCreate an Event ContactDelete an Event Contact
Grants
Get Grants for a ContactGet GrantGet a Grant by Reference IDGet the Gifts applied to a GrantCreate a GrantUpdate a GrantDelete a GrantGet Grant Custom Fields AvailableGet Grant Query OptionsQuery Grants
Volunteering-Volunteer Opportunity
Get Volunteer OpportunitiesGet Volunteer OpportunityCreate a Volunteer OpportunityUpdate a Volunteer OpportunityDelete a Volunteer OpportunityGet Custom Fields AvailableGet Query OptionsQueries Volunteer Opportunities
Volunteering-Volunteer
Get Volunteers for a Volunteer OpportunityGet VolunteerSearch for VolunteersCreate a VolunteerDelete a VolunteerGet Query OptionsQuery Volunteers
Volunteering-Volunteer Attendance
Get Volunteer Attendance for a VolunteerGet Volunteer AttendanceCreate a Volunteer AttendanceUpdate a Volunteer AttendanceDelete a Volunteer Attendance
Volunteering-Volunteer Organizer
Get Volunteer OrganizersGet Volunteer OrganizerCreate a Volunteer OrganizerDelete a Volunteer Organizer
Emails-Email
Get EmailsSend an Email to a list of Contacts
Emails-Email List
Search for an Email ListAdd Individuals to an Email List
Reminders (Deprecated)
Get Active Reminders (for current user)Get Saved Reminders (for current user)Get Active Manual Reminders by ContactGet Inactive Manual Reminders by ContactGet Unresolved Manual Reminders by ContactCreate Manual ReminderCreate Recurring ReminderCreate Milestone ReminderUpdate Recurring ReminderUpdate Milestone Reminder.Complete ReminderDismiss ReminderGet Reminder TypesGet Reminder Source TypesGets Milestone TypesGets Reminder Frequency Types
Tasks
Create a TaskGet Task TypesQuery TasksGet Task Query Options
Webhooks
Get a WebhookCreate a WebhookUpdate a WebhookSet the active state of a WebhookDelete a Webhook
Introduction
Reference
Account and Permissions-Authentication Token
Get Token
Account and Permissions-Organization
Get the Organizations the current user belongs toGet the Current Organization for the current userSwitch the Current Organization
Account and Permissions-Permission
Get Permissions for the current user
Contacts and Individuals-Contacts-How to Get Contacts
Get a ContactGet a Contact by Reference Source and IDGet a Contact by Reference IDGet Contacts by Tag IDFind a Contact by Email Address or Reference Source and IDFind all Contacts that match, fully or partially, the given search parametersFind all Contacts within a given proximity of a geocoordinateGet the Activity for the Contacts the current user is followingGet the Contacts the current user is following
Contacts and Individuals-Contacts-How to Create and Update Contacts
Create a ContactUpdate a ContactArchive a ContactUnarchive a ContactFollow or Unfollow a Contact for the current user
Contacts and Individuals-Contacts-Working with Collections
Get Custom Collections for ContactsCreate Collection for a ContactUpdate Collection for a ContactDelete Collection for a Contact
Contacts and Individuals-Contacts-Contact Imports
Create a Contact that will go through the import processCreate a Contact Import that will be processed for changes and duplicates
Contacts and Individuals-Contacts-Configuration
Get Contact Name Prefixes and TitlesGet Contact TypesGet Contact Custom Fields Available
Contacts and Individuals-Contacts-Contact Queries
Get Contact Query OptionsQuery Contacts with Abbreviated DetailsQuery Contacts with Full Details
Contacts and Individuals-Contacts-Receipts
ReceiptsGet Receipt
Contacts and Individuals-Individuals-How to Get Individuals
Get Individuals for a ContactGet an IndividualFind an individual by email addressGets the avatar for a specified contact individual
Contacts and Individuals-Individuals-How to Create and Update
Create an IndividualUpload the avatar for an IndividualUpdate an IndividualDelete an Individual
Contacts and Individuals-Individuals-Working with Collections
Get Custom Collections for IndividualsCreate Collection for an IndividualUpdate Collection for an IndividualDelete Collection for an Individual
Contacts and Individuals-Individuals-Configuration
Gets the custom fields for contact individuals
Contacts and Individuals-Individuals-Individual Queries
Get Individual Query OptionsQuery Individuals
Contacts and Individuals-Individuals-Email Lists
Get Email Lists for an Individual
Contacts and Individuals-Contact Addresses
Get the Contact Addresses for a ContactGet a Contact AddressCreate a Contact AddressUpdate a Contact AddressArchive a Contact AddressUnarchive a Contact AddressDelete a Contact Address
Contacts and Individuals-Contact Methods
Get Contact Method TypesGet Contact Methods Types related to the Base TypeGet a Contact MethodCreate a Contact Method for an IndividualUpdate a Contact MethodArchive a Contact MethodUnarchive a Contact MethodDelete a Contact Method
Contacts and Individuals-Contact Notes
Get the Notes for a ContactGet the Important Notes for a ContactGet a NoteCreate a Note for a ContactCreate a Note using an EmailUpdate a NoteDelete a NoteGet Contact Note Query OptionsQuery Contact NotesGet Contact Note TypesGets the custom fields for contact note
Contacts and Individuals-Contact References
Create a Contact ReferenceDelete a Contact Reference
Contacts and Individuals-Tags
Get all TagsFind all Tags that match, fully or partially
Contacts and Individuals-Contact Tags
Get Tags for a ContactCreate a Contact TagDelete a Contact Tag
Contacts and Individuals-Organization Groups
Get all Organization GroupsGet Organization Groups for a ContactGet the Contacts in an Organization GroupGet an Organization GroupAssign a Contact to an Organization GroupRemove a Contact from an Organization Group
Contacts and Individuals-Relationships
Get Relationships for a ContactCreate a RelationshipUpdate a RelationshipDelete a RelationshipGet Relationship Types
Contacts and Individuals-Tributes
Search for TributesCreate a TributeUpdate a Tribute
Giving-Gifts-How to Get Gifts
Get Gifts for a ContactGet Gifts for a Contact by Reference IDGet Passthrough Gifts for a ContactGet a GiftGet a Gift by Transaction Source and ID
Giving-Gifts-How to Create and Update Gifts
Create a Gift *not recommended*Create many Gifts *not recommended*Create a Reversing TransactionUpdate a GiftUpdate many GiftsDelete a Gift
Giving-Gifts-Gift Imports
Create a Gift TransactionCreate a Batch of Gift Transactions
Giving-Gifts-Configuration
Get Gift Custom Fields AvailableGet Non-Cash Gift Types Available
Giving-Gifts-Gift Queries
Get Gift Query OptionsQuery Gifts with Abbreviated DetailsQuery Gifts with Full Details
Giving-Gift Designations
Get Gift Designation Query OptionsQuery Gift Designations
Giving-Gift Asks
Get Gift Asks for a ContactGet the Gifts applied to a Gift AskGet a Gift AskCreate a Gift AskUpdate a Gift AskGet Gift Ask Custom Fields AvailableGet Gift Ask Query OptionsQuery Gift Asks
Giving-Planned Gifts
Get Planned Gifts for a ContactGet Planned GiftGet Gifts Applied to a Planned GiftCreate a Planned GiftUpdate a Planned GiftGet Planned Gift Custom Fields AvailableGet Planned Gift Query OptionsQuery Planned Gifts
Giving-Pledges
Get Pledges for a ContactGet PledgeCreate a PledgeUpdate a PledgeWrite-off the PledgeGet Pledge Custom Fields AvailableGet Pledge Query OptionsQuery Pledges
Giving-Premiums
Get PremiumGet Premium using a unique CodeFind PremiumsCreate a PremiumUpdate a PremiumIncrement the inventory countDecrement the inventory countGet Premium Custom Fields AvailableQuery PremiumsGet Premium Query Options
Giving-Recurring Gifts
Get Recurring Gifts for a ContactGet a Recurring GiftCreate a Recurring GiftUpdate a Recurring GiftCancel a Recurring GiftGet Recurring Gift Custom Fields AvailableGet Recurring Gift Query OptionsQuery Recurring Gifts
Giving-Recurring Gift Payments
Get Payments for a Recurring Gift
Campaigns-Campaigns
Get CampaignGets Campaign StepsGet Campaign Query OptionsQuery Campaigns
Campaigns-Communications
Get Communications for a CampaignGet CommunicationGet Channel TypesGet Communication TypesCreate CommunicationQuery CommunicationsCommunication Query Options
Campaigns-Segments
Get the Segments for a ContactGet a SegmentGet a Segment using a unique CodeFind SegmentsCreate a SegmentUpdate a Segment
Projects-How to Get Projects
Get ProjectGet a Project using a unique CodeFind Projects
Projects-How to Create and Update Projects
Create a ProjectUpdate a ProjectUpdate many ProjectsTemporarily Change Project Inventory StatusUpdate Project Balance
Projects-Configuration
Get Project Custom Fields AvailableGet Project Types
Projects-Project Queries
Get Project Query OptionsQuery Projects
Projects-Project Expenses
Get Project Expenses for a ProjectGet Project ExpenseCreate a Project ExpenseCreate many Project ExpensesUpdate a Project Expense
Projects-Project Notes
Get Notes for a ProjectGet Project NoteCreate a Project NoteUpdate a Project NoteDelete a Project NoteGet Project Note Types
Projects-Project Roles
Get Project Roles for a ContactGet Project Roles for a ProjectGet Project RoleCreate a Project RoleUpdate a Project RoleDelete a Project RoleGet Project Role Types
Events-Event
Get EventsGet an EventFind an EventCreate an EventUpdate an EventDelete an EventGet the Event TypesGet Event Custom Fields AvailableGet Event Query OptionsQuery Events
Events-Event Attendees
Get Event Attendees for an EventGet an Event AttendeeCreate an Event AttendeeUpdate an Event AttendeeDelete an Event AttendeeGet Event Attendee Custom Fields AvailableGet Event Attendee Query OptionsQuery Event Attendees
Events-Event Contacts
Get Event Contacts for an EventGet an Event ContactCreate an Event ContactDelete an Event Contact
Grants
Get Grants for a ContactGet GrantGet a Grant by Reference IDGet the Gifts applied to a GrantCreate a GrantUpdate a GrantDelete a GrantGet Grant Custom Fields AvailableGet Grant Query OptionsQuery Grants
Volunteering-Volunteer Opportunity
Get Volunteer OpportunitiesGet Volunteer OpportunityCreate a Volunteer OpportunityUpdate a Volunteer OpportunityDelete a Volunteer OpportunityGet Custom Fields AvailableGet Query OptionsQueries Volunteer Opportunities
Volunteering-Volunteer
Get Volunteers for a Volunteer OpportunityGet VolunteerSearch for VolunteersCreate a VolunteerDelete a VolunteerGet Query OptionsQuery Volunteers
Volunteering-Volunteer Attendance
Get Volunteer Attendance for a VolunteerGet Volunteer AttendanceCreate a Volunteer AttendanceUpdate a Volunteer AttendanceDelete a Volunteer Attendance
Volunteering-Volunteer Organizer
Get Volunteer OrganizersGet Volunteer OrganizerCreate a Volunteer OrganizerDelete a Volunteer Organizer
Emails-Email
Get EmailsSend an Email to a list of Contacts
Emails-Email List
Search for an Email ListAdd Individuals to an Email List
Reminders (Deprecated)
Get Active Reminders (for current user)Get Saved Reminders (for current user)Get Active Manual Reminders by ContactGet Inactive Manual Reminders by ContactGet Unresolved Manual Reminders by ContactCreate Manual ReminderCreate Recurring ReminderCreate Milestone ReminderUpdate Recurring ReminderUpdate Milestone Reminder.Complete ReminderDismiss ReminderGet Reminder TypesGet Reminder Source TypesGets Milestone TypesGets Reminder Frequency Types
Tasks
Create a TaskGet Task TypesQuery TasksGet Task Query Options
Webhooks
Get a WebhookCreate a WebhookUpdate a WebhookSet the active state of a WebhookDelete a Webhook
HomeReferenceWebhooks

Webhooks

Number of APIs: 5

  1. Get a Webhook GET {{baseUrl}}/api/Webhook/:webhookId

  2. Create a Webhook POST {{baseUrl}}/api/Webhook

  3. Update a Webhook PUT {{baseUrl}}/api/Webhook/:webhookId

  4. Set the active state of a Webhook PUT {{baseUrl}}/api/Webhook/:webhookId/Active?active=<boolean>

  5. Delete a Webhook DELETE {{baseUrl}}/api/Webhook/:webhookId

Previous
Get Task Query Options
Next
Get a Webhook