Overview

sheepAPI v2 (2.0.0)

SheepAPI v2 is the primary API for the sheepCRM platform, served from sls-api.sheepcrm.com. It provides RESTful access to contacts, events, segments, search, membership, finance, and more.

Who this is for

sheepAPI v2 is designed for developers building integrations, partner applications, and custom workflows on top of sheepCRM. If you are building something new, this is the API you should use.

Base URL

All endpoints are served from a single gateway:

https://sls-api.sheepcrm.com

Authentication

All requests require a Bearer token passed in the Authorization header. See the Authentication guide for details on obtaining and using API keys.

Authorization: Bearer YOUR_API_KEY

What’s available

Domain	Description
Contact	Avatars, display names, contact summaries, and personal details
Events	Event listings, bookings, tickets, orders, attendance, and rebasing
Segments	Segment queries, trees, counts, lookups, and Excel export
Search	Global search across contacts, events, and vehicles, plus person lookup and help article search
Membership	Member summaries, detail views, and membership records
Finance	Invoice display and signed invoice access
People	Person find, communications, personal details, and membership history
Export	Event attendance and order exports with metadata

Conventions

Bucket: Every request is scoped to a flock (database) identified by the {bucket} path parameter — for example, example in /events/v2/example/.
Resource URIs: Records are identified by Sheep URIs in the format /{bucket}/{resource_type}/{uid}/.
Pagination: List endpoints return paged results. See HTTP Conventions for details.
Errors: Standard HTTP status codes — 400 for bad requests, 401 for missing credentials, 403 for insufficient permissions, 404 for not found.

Getting started

Obtain an API key
Review HTTP conventions
Browse the endpoints below — each one includes parameters, response schemas, and example payloads

Report any inaccuracies or omissions to support@sheepcrm.com.

OpenAPI version: 3.0.0