API Version 2

The version 2 API is delivered through AWS Lambda and uses the sls-api.sheepcrm.com domain.

People Endpoints

The following endpoints are designed for access to the data of a single person contact.

Equity, Diversity and Inclusion (EDI)

Policy: person.edi.detail

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/edi/detail
Authorization: Bearer $API_KEY

Policy: person.edi.summary

“Summary” hides the values, showing just whether the fields have been populated:

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/edi/summary
Authorization: Bearer $API_KEY

Finance

Policy: person.finance.summary

“Summary” shows only recent past and immediate future payments:

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/finance/summary
Authorization: Bearer $API_KEY

Policy: person.finance.all

“All” includes all payments and all financial external IDs:

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/finance/all
Authorization: Bearer $API_KEY

Groups / Teams

The list of all groups/teams that the person is a member of.

Policy: person.group.summary

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/group/summary
Authorization: Bearer $API_KEY

The list of all groups/teams augmented with group data and available roles and status fields.

Policy: person.group.detail

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/group/detail
Authorization: Bearer $API_KEY

Health Data

Policy: person.health.detail

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/health/detail
Authorization: Bearer $API_KEY

Policy: person.health.summary

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/health/summary
Authorization: Bearer $API_KEY

Sessions

Person Session Summary is a list of attendance records for the person within a recent time window (typically 45 days before and 45 days after today).

Parameter	Description
`limit`	The number of sessions to return. Default is 7.

Policy: person.session.summary

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/session/summary
Authorization: Bearer $API_KEY

Policy: person.session.detail

Person Session Detail includes empty sessions for bookings linked to segments or groups that this person belongs to:

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/session/detail
Authorization: Bearer $API_KEY

Policy: person.session.all

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/session/all
Authorization: Bearer $API_KEY

Future sessions only:

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/session/future
Authorization: Bearer $API_KEY

Past sessions only:

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/session/past
Authorization: Bearer $API_KEY

Vehicles

Policy: person.vehicles.all

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/vehicles/all
Authorization: Bearer $API_KEY

Vehicle detail augments the stored data with live data from DVLA.

Policy: person.vehicles.detail

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/person/{uid}/vehicles/detail
Authorization: Bearer $API_KEY

Organisation Endpoints

The following endpoints are designed for access to the data of a single organisation contact.

Summary Data

Policy: organisation.summary

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/organisation/{uid}/summary
Authorization: Bearer $API_KEY

Group Endpoints

Policy: group

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/group/
Authorization: Bearer $API_KEY

Policy: group.all

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/group/all
Authorization: Bearer $API_KEY

Group Members

Parameter	Description
`expansions`	`open_tasks` — include the number of open tasks per group member.
`status`	Filter group members by status.

Policy: group.members

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/group/{uid}/members/all
Authorization: Bearer $API_KEY

Sessions Summary for a Group

Bookings plus/minus 90 days with a summary of session attendance.

Policy: group.session.summary

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/group/{uid}/session/summary
Authorization: Bearer $API_KEY

Segments

Policy: segment

All active segments:

GET https://sls-api.sheepcrm.com/segments/v2/{bucket}/segments/
Authorization: Bearer $API_KEY

Policy: segment.all

All segments (active and inactive):

GET https://sls-api.sheepcrm.com/segments/v2/{bucket}/segments/all/
Authorization: Bearer $API_KEY

Policy: segment

All active segments for a view context:

GET https://sls-api.sheepcrm.com/segments/v2/{bucket}/segments/{view_context}/
Authorization: Bearer $API_KEY

System / User

User Permissions

Returns the user permissions for your user:

GET https://sls-api.sheepcrm.com/api/v2/{bucket}/user/permissions
Authorization: Bearer $API_KEY

Additional Endpoints

The following endpoints are available but not yet fully documented:

Endpoint	Description
`GET /api/v2/{bucket}/find/person`	Find a person contact.
`GET /api/v2/{bucket}/{resource_type}/{uid}/display`	Get the display value for a resource.
`GET /api/v2/{bucket}/{resource_type}/{uid}/image/{field}/{style}`	Get an image for a resource field.