Scheduled for Deprecation

Caution

The sheepAPI v1 is scheduled for deprecation. No end date has been set at this time, and the timeline will be subject to consultation with API consumers.

What is happening

The Core API — served at api.sheepcrm.com/api/v1/ — is being superseded by the sheepAPI v2, which provides a modern, comprehensive API gateway at sls-api.sheepcrm.com.

The SLS API covers contacts, events, segments, search, audit, finance, forms, and more, with consistent authentication, pagination, and error handling across all endpoints.

What “scheduled for deprecation” means

1. The V1 API continues to work today. No endpoints have been removed or disabled.
2. No new features will be added to V1. All new development is on sheepAPI v2.
3. A deprecation timeline will be published after consultation with partners and API consumers. We will not set an end date unilaterally.
4. You will receive advance notice. When a timeline is agreed, we will communicate it directly to all registered API consumers and publish it here.

Immediate requirement: the APPLICATION header

Danger

All third-party V1 API calls must include the APPLICATION header. Unattributed V1 calls — those without an APPLICATION header — will be the first to be phased out, beginning summer 2026.

Every request to the V1 API should include the APPLICATION HTTP header to identify the source of the request. The value should be a short string identifying your organisation and the application or service making the call:

GET https://api.sheepcrm.com/api/v1/$FLOCK/
Authorization: Bearer $API_KEY
APPLICATION: YourOrg/YourApp/1.0

The format is Organisation/Application/Version — for example:

• AgencyX/MemberPortal/2.1
• Acme/EventSync/1.0
• SmithDev/DataExport/3.2

Why this matters: We use the APPLICATION header to understand which integrations depend on V1, to communicate directly with you about deprecation timelines, and to provide better support. Calls without this header are unattributed — we cannot contact you, we cannot assess the impact of changes on your integration, and we cannot offer a managed migration path.

What happens to unattributed calls: Starting in summer 2026, V1 API calls that do not include the APPLICATION header will begin to be phased out. This will happen before any deprecation of attributed calls. If you are currently making V1 calls without this header, adding it is the single most important thing you can do to protect your integration.

What you should do now

1. Add the APPLICATION header to all V1 API calls immediately. This is the most urgent action — unattributed calls will be phased out first.
2. New integrations should use the sheepAPI v2 exclusively.
3. Existing integrations should begin planning a migration to sheepAPI v2. There is no urgency for attributed calls, but early migration avoids future time pressure.
4. Review sheepAPI v2 reference to identify the equivalent endpoints for your current V1 usage. Most V1 operations have a direct SLS equivalent.

Consultation process

We are committed to giving API consumers a voice in the deprecation timeline. If you rely on the V1 API, we want to hear from you:

• What V1 endpoints do you depend on?
• Are there SLS equivalents you’ve already migrated to?
• What notice period would you need to complete a migration?

Please contact support@sheepcrm.com with the subject line “V1 API Deprecation Consultation” to participate.

Migration resources

V1 pattern	SLS equivalent
api.sheepcrm.com/api/v1/{bucket}/person/	sls-api.sheepcrm.com/api/v2/{bucket}/{resource_type}/{uid}/
api.sheepcrm.com/api/v1/{bucket}/booking/	sls-api.sheepcrm.com/events/v2/{bucket}/
api.sheepcrm.com/api/v1/{bucket}/segment/	sls-api.sheepcrm.com/segments/v2/{bucket}/
api.sheepcrm.com/api/v1/{bucket}/search/	sls-api.sheepcrm.com/search/v2/{bucket}/

A detailed migration guide will be published alongside the deprecation timeline.

Key dates

Milestone	Date
Deprecation notice published	April 2026
Consultation period opens	April 2026
Unattributed V1 calls phased out	Summer 2026
Deprecation timeline confirmed	To be determined (subject to consultation)
V1 API end of life	To be determined (subject to consultation)