neon_get_organization_profile
Get the organization profile
Fetch the Neon CRM organization these credentials belong to — its name, org ID and app URL. A cheap way to confirm the org ID and API key work. Neon: GET /properties/organizationProfile.
無需輸入參數。
neon_list_accounts
List accounts
List constituent accounts (individuals and companies), optionally filtered by email, first or last name, or type. Returns accountId, names, email and userType. For richer queries use neon_search. Neon: GET /accounts.
輸入參數emaillast_namepage_sizeuser_typefirst_namecurrent_page
neon_get_account
Get one account
Fetch one account in full — returned as individualAccount or companyAccount with its primary contact, addresses, consent, custom fields, current membership status and timestamps. Neon: GET /accounts/{id}.
輸入參數account_id必填
neon_list_search_fields
List search or output fields
Discover the field names neon_search accepts for a resource: kind=searchFields gives filterable fields with their allowed operators; kind=outputFields gives the columns you can return (standard field names plus custom fields with numeric ids). Call this before neon_search. Neon: GET /{resource}/search/searchFields or /outputFields.
輸入參數kind必填resource必填
neon_search
Search records
Report-style search over accounts, donations (includes pledges and pledge payments), activities or events. Give filter criteria (field + operator + value), the output columns to return (standard field NAMES as strings, or custom-field IDS as integers — both from neon_list_search_fields), and 0-based pagination. Results come back as searchResults rows keyed by output field name, plus pagination totals. Neon allows only ONE concurrent search per endpoint. Neon: POST /{resource}/search.
輸入參數resource必填page_sizesort_columncurrent_pageoutput_fields必填search_fields必填sort_direction
neon_list_account_donations
List an account's donations
List one account's donations (amount, date, fund, campaign, purpose, status, payments), newest first by default. Neon: GET /accounts/{id}/donations.
輸入參數account_id必填sort_columncurrent_pagesort_direction
neon_list_account_memberships
List an account's memberships
List one account's membership history — level, term, start and end dates, fee, status (e.g. SUCCEEDED/FAILED) and auto-renewal. Filter to active or the primary active membership. Neon: GET /accounts/{id}/memberships.
輸入參數is_activepage_sizeaccount_id必填sort_columncurrent_pagesort_directionprimary_active_membership
neon_list_account_event_registrations
List an account's event registrations
List the event registrations one account has made, optionally for a single event. Neon: GET /accounts/{id}/eventRegistrations.
輸入參數event_idaccount_id必填current_pagesort_direction
neon_get_donation
Get one donation
Fetch one donation — amount, date, fund, campaign, purpose, source, tribute, soft-credit solicitor, payments and status. Neon: GET /donations/{id}.
輸入參數donation_id必填
neon_get_membership
Get one membership
Fetch one membership — level, term, dates, fee, status, auto-renewal, sub-members and payments. Neon: GET /memberships/{membershipId}.
輸入參數membership_id必填
neon_list_membership_levels
List membership levels
List the organization's membership levels (id, code, description, rank, type, status). Neon: GET /memberships/levels.
輸入參數statuspage_sizecurrent_page
neon_list_events
List events
List events, filterable by name, category, date window, published or archived state. Dates are YYYY-MM-DD. Only Neon's legacy events are exposed by the API. Neon: GET /events.
輸入參數archivedpage_sizeevent_namecurrent_pageend_date_afterevent_categoryend_date_beforepublished_eventstart_date_afterstart_date_before
neon_get_event
Get one event
Fetch one event — name, summary, dates, location, capacity, category, campaign, registration and financial settings. Neon: GET /events/{id}.
輸入參數event_id必填
neon_list_event_registrations
List an event's registrations
List the registrations for one event — registrant account, tickets and attendees, amount, payments. Optionally only one registrant. Neon: GET /events/{id}/eventRegistrations.
輸入參數pageevent_id必填page_sizesort_directionregistrant_account_id
neon_list_campaigns
List campaigns
List fundraising campaigns (id, code, name, status). Neon: GET /campaigns.
無需輸入參數。
neon_get_campaign
Get one campaign
Fetch one campaign — dates, goal, fund, purpose, parent campaign, status, page URLs and fundraising statistics. Neon: GET /campaigns/{id}.
輸入參數campaign_id必填
neon_get_activity
Get one activity
Fetch one activity (a logged interaction or task) — subject, note, dates, linked accounts, assigned users, status and priority. Neon: GET /activities/{id}.
輸入參數activity_id必填
neon_list_properties
List lookup values
List one of the organization's lookup lists — the ids other tools need: funds, purposes, sources, solicitation methods, activity statuses and system time zones (for neon_create_activity), system users, individual and company types, event categories, countries, states/provinces, genders, prefixes. Neon: GET /properties/{name}.
輸入參數name必填
neon_create_account
Create an account
Create a constituent account: an INDIVIDUAL (a person) or a COMPANY (with company_name, plus an optional primary contact). Neon's Account Match may merge it into an existing account with the same name and email, so check neon_list_accounts by email first. Returns the new id. Neon: POST /accounts.
輸入參數citytype必填emailphoneemail2zip_codejob_titlelast_namesource_idcountry_idfirst_namephone_type另有 7 個
neon_update_account
Update an account
Change an account's name, email, job title, company name or do-not-solicit / email opt-out flags. Only the fields you pass are changed (PATCH). The type must match the account (see neon_get_account). Addresses are not edited here. Neon: PATCH /accounts/{id}.
輸入參數type必填emailemail2job_titlelast_nameaccount_id必填first_namemiddle_namecompany_nameemail_opt_outpreferred_nameno_solicitation
neon_create_activity
Log an activity
Create an activity — log an interaction with a constituent (call, meeting, note) or schedule a task. Needs a subject, a start date, a time zone id (neon_list_properties name=systemTimezones), a status id (name=activityStatuses) and a priority; link it to accounts and assign it to system users. Returns the new id. Neon: POST /activities.
輸入參數notesubject必填end_dateend_timepriority必填status_id必填start_date必填start_timeaccount_idstime_zone_id必填system_user_ids
neon_update_activity
Update an activity
Change an activity's subject, note, status (e.g. mark it completed) or priority. Only the fields you pass are changed (PATCH). Neon: PATCH /activities/{id}.
輸入參數notesubjectprioritystatus_idactivity_id必填