SheepAPI Core

Contents:

• Getting Started
  • Get an auth token
  • Making an authenticated request
  • Declaring the name of your application
  • List available databases (flocks)
  • Create a resource
  • Get all resources of a given type
  • Query logic
  • Paging results
  • Get a single resource record
  • Delete a single record
  • Update a record
  • Obfuscate a single record
  • Get the display value for a single resource record
  • Get the avatar for a single resource record
  • Getting a signed URL
  • Recalculating a record
  • Touch
  • Asynchronous tasks
• Contacts
  • Find a person
  • Find an organisation
  • Summary profile data
  • Personal details for a person
  • Communications for a person
  • Badges
  • Evidence records
  • Privacy / GDPR
  • Membership
  • Get all the connections for a contact
  • Adding connections to a contact
  • Forms
  • Invoices
  • Finding duplicates
  • Merging duplicates
• Admin Membership Calls
  • Check the status of a membership (from an email addresss)
  • Create a membership record
  • Activate a pending membership
  • Cancel a membership
  • Renew a membership
  • Remove payment plan from membership
  • Unpack payment plan from membership
  • Unpack payment plan from membership
  • Add a linked member
  • Storing additional data on a membership record
  • Membership certificate
  • Membership invoice
• Bulk Admin Membership Calls
  • Get all members
  • Get all active members
  • Get all non-active members
  • Get all recently added members
• Automatic membership numbers
• Sheep Achievements
  • Example use cases:
  • Achievement Types
  • Achievements
• Events (Bookings)
  • Getting events
  • Create a new event
  • Accept a event enquiry
  • Reject a event enquiry
  • Cancel a event
  • Uncancel a event
  • Enable stock control
  • Check ticket stock
  • Create stock for an event
  • Remove ticket stock
  • Allocate a ticket from stock
  • Return a ticket to stock
  • Event series
  • View events in a series
  • Create a series
  • Delete from a series
  • Remove a single event from a series
  • Extend a series
• Comments
  • Terminology
  • Start a thread
  • View all threads
  • Delete a thread
  • View a specific thread
  • Comment on a thread
  • Delete a comment
• Data Events
  • General variations
  • Membership Data Events
  • Payment Events
  • Other Data Events
• Actions
  • Viewing the events and actions configured
  • Configuring actions
  • Webhook Notes
  • Advanced Actions
  • Bulk one-off actions
• sheepFlow
  • Flow Terminology
  • Get available boards
  • Get a board with full config
  • Get a board with column config
  • Get a board with full config and cards
  • Updating cards (bulk actions)
  • Configuring a board
  • Example Column Configs:
  • Setup through the user interface
• sheepForms
  • Form Fields
  • Create a new form
  • Sections in a form template
  • Questions in a form section
  • Form Responses
  • Submitting answers to a form response
  • Commenting on a form response
  • Provide feedback on a form response
  • Scoring a form
  • Assigning a user to a form response
• Journals
  • Notes
  • Documents
  • Messages for a contact
  • Tasks
• Messages
  • Message Types
  • Message Status
  • Creating a message
  • Sending a message
• Notifications
• Partners
  • GoCardless
  • MailChimp
  • Xero
  • Generic Partner Webhook
  • Pre-configured Webhooks
  • Generic Ticketing
  • GoCardless
• Permissions
• Reports
  • Segment based reports & bulk actions
  • Requesting a report/action
  • Report Types
  • Sending messages to a segment
• Data Schemas
  • achievement
  • achievement_type
  • action
  • activity
  • attendee
  • badge
  • bookable
  • booking
  • comment
  • connection
  • consent
  • contact
  • contract
  • dbs
  • donation
  • donation_appeal
  • donation_restriction
  • equal_opportunities
  • evidence
  • externalid
  • flow_board
  • flock_settings
  • form_question
  • form_response
  • form_section
  • form_template
  • grant
  • grant_award
  • grant_data
  • group
  • group_member
  • health
  • hiring_slot_definition
  • journal
  • lawful_basis
  • legitimate_interest
  • lineitem
  • mandate
  • member
  • membership
  • membership_type
  • message
  • moment
  • organisation
  • page
  • page_document
  • page_index
  • page_news
  • payment
  • payment_plan
  • person
  • pledge
  • processing_operation
  • provenance
  • quote
  • reservation
  • segment
  • service_type
  • sheep_event
  • sheep_form
  • sku
  • template
  • ticket
  • ticket_type
  • trigger
  • user_group
  • venue
  • vehicle
  • webhook
• Schemas
  • Get the schema for a resource type
  • Schema overloading
• Settings
  • General
  • Brand
  • Financial
  • Misc
  • Membership
  • Partners
  • Privacy
  • Forms
• System
  • Health Check
  • Worker Queues (Internal use only)
  • Validate an email address
  • Group by and Count
  • Data lookups
  • GDPR Purposes
• Users
  • User Info
  • Add a user to the database
  • Change the roles for a user
  • Suspending or removing a user
• User Groups
  • Get all user groups
  • Update a user group
• Flock permissions
  • Get the flock permissions for a user
  • Adding a user group to the flock permissions of a user
  • Policies
  • Example Policies:
• API Version 2
  • People Endpoints
  • Organisation Endpoints
  • Group Endpoints
  • Segments
  • System / User
  • To be documented