Skip to content
sheepCRM Docs
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Getting Started
Overview
Authentication
HTTP Conventions
Terminology
sheepAPI (SLS)
Overview
Contact
Avatar
Display
Contact - summary
Person - communications detail
Person - personal detail
Person - membership list
Search
Find Person (specific)
Search - 'Global'
Search - Help
Search - Vehicles
Search - People
People
Find Person (specific)
Person - communications detail
Person - personal detail
Person - membership list
Membership
Person - membership list
Membership - single
Membership - single detail
Membership Plan - Extra settings
Membership Plan - Extras - Add additional field
Membership Plan - Extras - Remove additional field
Membership Plan - Extras - Add condition
Membership Plan - Extras - Remove condition
Audit
Audit
Audit - Single Record
Audit - provenance
Events
Events - List
Events - List by state
Events - Single
Event - Rebase ticket dates
Event - Rebase questions
Events - Single summary
Event - Attendance
Event - Attendance
Event - Attendance
Event - Attendance Export
Event - Available Ticket Types
Event - Orders
Event - Orders for a contact
Event - Orders Export
Event - Meta data for the Orders Export
Event Tickets
Event Order - get
Event Order - delete
Event Order - questions
Export
Event - Attendance Export
Event - Orders Export
Event - Meta data for the Orders Export
Event Tickets
Fieldset - list of fields
Fieldset - create a fieldset
Fieldset - delete
Fieldset - single fieldset
Settings
Membership Plan - Extra settings
Membership Plan - Extras - Add additional field
Membership Plan - Extras - Add condition
Get all email senders
Create a new email sender
Get email sender by UID
Update email sender by UID
Delete email sender by UID
Internal
Membership Plan - Extras - Remove additional field
Membership Plan - Extras - Remove condition
Request Partner Sync
Request a warehouse build
Create new composite user policy
Create group policies
Add a policy to all group leaders
Create a single policies
Partners
Request Partner Sync
Request a warehouse build
User Policy
Create new composite user policy
Create group policies
Add a policy to all group leaders
Create a single policies
Finance
Invoice - Single
Invoice - Single with signature
Segments
Segments - All active segments
Segments - All segments
Segments - Create a new segment
Segments - Find a segment by name
Segments - Get segment tree structure
Segments - Get segments by view context
Segment - Config
Segment - Count
Segment - Lookup
Segment - All records
Segment - Excel export
Segment - PDF export
Segment - XLSX export
Segment - Sync Mailchimp
Segment - Replace Records
Segment - Delete All Records
Fieldset - list of fields
Fieldset - create a fieldset
Fieldset - delete
Fieldset - single fieldset
App
App - Request empty form responses
Allocate a form response to a contact
Delete the contact on a form response
App - Invoice PDF
App - Giving PDF
App - Membership card PDF
App - Public Pages
Forms
App - Request empty form responses
Allocate a form response to a contact
Delete the contact on a form response
PDF
App - Invoice PDF
App - Giving PDF
App - Membership card PDF
Usage API
Overview
Clients
Overview
List all clients
Get client detail
Get client usage history
Snapshots
Overview
Get all snapshots for a date
Admin
Overview
Trigger manual collection
Warehouse API
Overview
Schema
Overview
Apply DDL schema and column comments
Migration
Overview
Run MongoDB → MotherDuck migration
Query
Overview
Execute a read-only SQL query
API v1
Overview
List collections with row counts and last update
List tables with row counts for a bucket
Browse table data (paginated)
Submit an async natural language query
Poll for async ask query result
Execute read-only SQL scoped to a bucket
List available reports
Get a report definition
Execute a pre-built report
Cross-Tenant
Overview
Submit a cross-tenant query
Poll for cross-tenant query result
Console API
Overview
Flocks
Overview
List all flocks
Get combined flock data
Get central flock record
Update central flock record
Get flock settings
Update flock settings
Get integration status
Trigger schema update
Pricing
Overview
List all plans
Create a new plan
Update a plan
List all packs
Create a new pack
Get a pack
Update a pack
Delete a pack
Migrate hardcoded pricing
Core API (V1)
Core API
Achievements
Events (Bookings)
Comments
Contacts
Data Events
sheepFlow
sheepForms
Journals
Membership
Messages
Permissions
Reports
Schemas
Settings
System
sheepTeams
Users
Self-Service API
Self-Service API
Authentication
Documents
Donations
Events
Forms
General
Interactions
Invoices
Membership
Messages
Payments
Privacy / GDPR
Member Profiles
Reservations
Teams
Users
Vehicles
Venue Hire
Integrations
Partner Integrations
GoCardless
Mailchimp
Xero
Guides
Solution Catalog
Client Setup
Forms
Membership
Payments
Search Guide
Policies
Policies
Asset Management
Business Continuity Plan
Fair Usage Policy
Incident Management
Information Security Policy
Risk Management
Select theme
Dark
Light
Auto
Overview
Cross-Tenant
Section titled “Cross-Tenant”
Admin-only endpoints for querying across all tenant databases
