API Version 2

The version 2 API is delivered through AWS lambda and uses the http://sls-api.sheepcrm.com/ domain.

see https://sls-api.sheepcrm.com/.well-known/docs.html

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

http 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 if the fields have been populated

http 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.

http 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

http 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

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

The list of all groups/teams that the person is a member of augmented with group data and available roles and status fields.

POLICY: person.group.detail

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

Health data

POLICY: person.health.detail

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

POLICY: person.health.summary

http 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)

limit

the number of sessions to return - default is 7

POLICY: person.session.summary

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

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

POLICY: person.session.detail

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

POLICY: person.session.all

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

POLICY: person.session.all

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

POLICY: person.session.all

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

Vehicles

POLICY: person.vehicles.all

http 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

http 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 org contact.

Summary data

POLICY: organisation.summary

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

Group Endpoints

POLICY: group

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

POLICY: group.all

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

Group Members

expansions

open_tasks - include the number of open tasks per group member

status

filter group members by stat

POLICY: group.members

http 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

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

Segments

POLICY: segment

All active segments

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

POLICY: segment.all

All segments active and inactive

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

POLICY: segment

All active segments for a view context

http 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

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

To be documented

• http: ‘GET /api/v2/{bucket}/find/person’

• http: ‘GET /api/v2/{bucket}/{resource_type}/{uid}/display’

• http: ‘GET /api/v2/{bucket}/{resource_type}/{uid}/image/{field}/{style}’