Skip to content
sheepCRM Docs

Journals

Notes

Section titled “Notes”

Since the early versions, Sheep has supported “journals” as general purpose notes, reminders, and logs. The journal data model still exists but the different use-cases have been separated for the user and the v2 API. The native v1 journal API is still used for writing new records and should be used for cross-category querying.

Policy: person.notes / organisation.notes / booking.notes

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

Documents

Section titled “Documents”

A read-only endpoint for accessing documents (files) attached to resources across the system. These API calls are designed to bring all file uploads into a single convenient place. Uploading new files should be actioned from the parent resource, e.g. journal note or evidence record.

Policy: person.documents / organisation.documents / booking.documents

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

Messages for a Contact

Section titled “Messages for a Contact”

A helper endpoint to provide all messages in one call: lifecycle email, bulk email, dropbox email. Mailchimp, SMS and post on demand will be added in future versions.

Policy: person.messages / organisation.messages

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

Tasks

Section titled “Tasks”

Tasks, also known as reminders. A task is a note with a due date and an assigned user.

Policy: person.tasks / organisation.tasks / booking.tasks

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