Download OpenAPI specification:Download
The sheepCRM API is a RESTful API that allows you to access and manipulate data in your sheepCRM database. Sheep was built with an API-first approach, so all of the functionality you see in the web interface is available via the API.
The API is designed to be used by developers to build custom integrations and applications. It is not designed to be used by end users, although some of the endpoints are available to end users via the self-service app.
Please report any inaccuracies or omissions to support@sheepcrm.com on the understanding that this documentation is a work in progress and will be updated regularly.
The avatar for the person or organisation If an image has been provided it will be returned as a redirect If no image has been provided a placeholder image will be generated based on the initials of the name.
bucket required | string (bucket) Example: example The bucket (client) name |
resource_type required | string (resource_type) Example: person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
The display name for the record e.g. the persons name or the organisation name
bucket required | string (bucket) Example: example The bucket (client) name |
resource_type required | string (resource_type) Example: person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
{- "display_value": "Caroline Smith"
}
get a summary of a contact (person or organisation) from their uri
contact_uri required | string (uri) Example: /example/person/6305f074683e800f3abe809e/ URIs are unique identifiers for resources in the system,
they are structured as follows |
get the communication details for a person e.g. email, phone, address
person_uri required | string (uri) Example: /example/person/6305f074683e800f3abe809e/ URIs are unique identifiers for resources in the system,
they are structured as follows |
Get the full membership history for a person, current and historic, use the /summary endpoint for a faster summary
person_uri required | string (uri) Example: /example/person/6305f074683e800f3abe809e/ URIs are unique identifiers for resources in the system,
they are structured as follows |
{- "contact_uri": "string",
- "count": 0,
- "memberships": [
- {
- "admin_contact": "string",
- "advise_lapse": true,
- "amount": 0,
- "auto_renew": true,
- "billing_contact": "string",
- "cancellation_date": "string",
- "created": "string",
- "currency": "string",
- "display_value": "string",
- "end_date": "string",
- "externally_managed": true,
- "gc_subscription_id": null,
- "gift_aid": true,
- "has_renewed": true,
- "lapse_reason": "string",
- "last_updated": "string",
- "linked_members": [
- "string"
], - "max_linked_members": 0,
- "member": "string",
- "membership_number": "string",
- "membership_plan_type": "string",
- "membership_record_status": "string",
- "membership_type": "string",
- "mute_communications": true,
- "next_membership_type": "string",
- "next_payment_plan": "string",
- "paid": true,
- "payment_date": null,
- "payment_method": "string",
- "payment_plan": "string",
- "payment_reference": null,
- "period": "string",
- "record_state": "string",
- "start_date": "string",
- "stripe_subscription_id": null,
- "tags": [
- "string"
], - "tax": "string",
- "uid": "string",
- "uri": "string",
- "user_interface": {
- "can_create_member": true,
- "can_delete_member": true,
- "can_edit_member": true,
- "can_restore_member": true,
- "policy_name": "string"
}, - "xero_account_code": null
}
]
}
check for a specific person contact from within sheepCRM, for general searching use the search endpoint. this call has been deprecated in favour of an identical call to the search endpoint /search/v2/{bucket}/person
bucket required | string |
title | string |
first_name | string |
last_name | string |
string | |
date_of_birth | string |
postal_code | string |
take_first_if_multiple | boolean |
search across the whole system /search/v2/{bucket}/?q=John+Smith
The global url is an alias: /search/v2/{bucket}/global
bucket required | string (bucket) Example: example The bucket (client) name |
q required | string (q) Example: q=john smith |
{- "results": [
- {
- "display_value": "John Smith",
- "id": "/example/person/6305f074683e800f3abe809e/",
- "primary_email": "john@smith.example.com",
- "primary_telephone": "+44 1234 56789",
- "resource": "person"
}
]
}
search for a specific vehicle by registration number, engine number or identifying number
bucket required | string (bucket) Example: example The bucket (client) name |
registration_number | string (registration_number) Example: registration_number=EK23 JWW Vehicle registration number |
engine_number | string (engine_number) Example: engine_number=1234567890 Vehicle engine number |
identifying_number | string (identifying_number) Example: identifying_number=1234567890 Vehicle identifying number (VIN in modern cars) |
check for a specific person contact from within sheepCRM, for general searching use the search endpoint. this call has been deprecated in favour of an identical call to the search endpoint /search/v2/{bucket}/person
bucket required | string |
title | string |
first_name | string |
last_name | string |
string | |
date_of_birth | string |
postal_code | string |
take_first_if_multiple | boolean |
get the communication details for a person e.g. email, phone, address
person_uri required | string (uri) Example: /example/person/6305f074683e800f3abe809e/ URIs are unique identifiers for resources in the system,
they are structured as follows |
Get the full membership history for a person, current and historic, use the /summary endpoint for a faster summary
person_uri required | string (uri) Example: /example/person/6305f074683e800f3abe809e/ URIs are unique identifiers for resources in the system,
they are structured as follows |
{- "contact_uri": "string",
- "count": 0,
- "memberships": [
- {
- "admin_contact": "string",
- "advise_lapse": true,
- "amount": 0,
- "auto_renew": true,
- "billing_contact": "string",
- "cancellation_date": "string",
- "created": "string",
- "currency": "string",
- "display_value": "string",
- "end_date": "string",
- "externally_managed": true,
- "gc_subscription_id": null,
- "gift_aid": true,
- "has_renewed": true,
- "lapse_reason": "string",
- "last_updated": "string",
- "linked_members": [
- "string"
], - "max_linked_members": 0,
- "member": "string",
- "membership_number": "string",
- "membership_plan_type": "string",
- "membership_record_status": "string",
- "membership_type": "string",
- "mute_communications": true,
- "next_membership_type": "string",
- "next_payment_plan": "string",
- "paid": true,
- "payment_date": null,
- "payment_method": "string",
- "payment_plan": "string",
- "payment_reference": null,
- "period": "string",
- "record_state": "string",
- "start_date": "string",
- "stripe_subscription_id": null,
- "tags": [
- "string"
], - "tax": "string",
- "uid": "string",
- "uri": "string",
- "user_interface": {
- "can_create_member": true,
- "can_delete_member": true,
- "can_edit_member": true,
- "can_restore_member": true,
- "policy_name": "string"
}, - "xero_account_code": null
}
]
}
Get the full membership history for a person, current and historic, use the /summary endpoint for a faster summary
person_uri required | string (uri) Example: /example/person/6305f074683e800f3abe809e/ URIs are unique identifiers for resources in the system,
they are structured as follows |
{- "contact_uri": "string",
- "count": 0,
- "memberships": [
- {
- "admin_contact": "string",
- "advise_lapse": true,
- "amount": 0,
- "auto_renew": true,
- "billing_contact": "string",
- "cancellation_date": "string",
- "created": "string",
- "currency": "string",
- "display_value": "string",
- "end_date": "string",
- "externally_managed": true,
- "gc_subscription_id": null,
- "gift_aid": true,
- "has_renewed": true,
- "lapse_reason": "string",
- "last_updated": "string",
- "linked_members": [
- "string"
], - "max_linked_members": 0,
- "member": "string",
- "membership_number": "string",
- "membership_plan_type": "string",
- "membership_record_status": "string",
- "membership_type": "string",
- "mute_communications": true,
- "next_membership_type": "string",
- "next_payment_plan": "string",
- "paid": true,
- "payment_date": null,
- "payment_method": "string",
- "payment_plan": "string",
- "payment_reference": null,
- "period": "string",
- "record_state": "string",
- "start_date": "string",
- "stripe_subscription_id": null,
- "tags": [
- "string"
], - "tax": "string",
- "uid": "string",
- "uri": "string",
- "user_interface": {
- "can_create_member": true,
- "can_delete_member": true,
- "can_edit_member": true,
- "can_restore_member": true,
- "policy_name": "string"
}, - "xero_account_code": null
}
]
}
Get a summary of a single membership record (a member record), use the /detail endpoint to get the full details
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
Get a summary of the membership details for a person, use the /all endpoint to get the full details
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
Get the extra settings for a membership plan
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
Add an additional user input field to a membership plan
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
label required | string The label for the field that will be shown to the user |
field | string The field name, if not provided the label will be slugified |
description required | string A description of the field, shown to the user |
form_type required | string Enum: "checkbox" "date" "email" "number" "person_record" "select" "tel" "text" "textarea" The type of field |
required | boolean Is this field required? |
options | Array of strings If the form_type is select, this is the list of options that will be shown to the user |
dob_required | boolean If the form_type is person_record, is the date of birth required? |
Remove an additional user input field from a membership plan
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
field required | string The field name to be removed |
Add a condition to a membership plan e.g. Age: Under 18
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
key required | string The key element of the condition |
value required | string The value element of the condition |
Remove a condition from a membership plan
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
key required | string The key element of the condition |
Pull audit log messages across the whole client for a time period Available as standard JSON packet or a list for easier reading Note the call is time limited to 20 seconds, so if you have a lot of audit messages you may need to reduce the limit and break into multiple calls
bucket required | string (bucket) Example: example The bucket (client) name |
limit | integer Default: 250 |
from | string (datetime) Example: from=2023-09-05T11:27:06.437000 A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm |
to | string (datetime) Example: to=2023-09-05T11:27:06.437000 A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm |
resource | string (resource_type) Example: resource=person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
format | string Default: "json" Enum: "json" "list" |
Pull audit log messages from a single record
bucket required | string (bucket) Example: example The bucket (client) name |
resource_type required | string (resource_type) Example: person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
limit | integer Default: 250 |
since_days | integer Default: 180 |
{- "results": [
- {
- "date": "2023-09-05T11:27:06.437000",
- "message": "string",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "user": "/example/person/6305f074683e800f3abe809e/",
- "revertable": true,
- "resource": "person",
- "clean_diff": [
- {
- "field": "string",
- "prev": "string",
- "value": "string",
- "verb": "change"
}
]
}
], - "count": 0,
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "related_uris": [
- "/example/person/6305f074683e800f3abe809e/"
]
}
All the events for a client within the past 14 days and next 90 Aliased as /events/v2/{bucket}/bookings
bucket required | string (bucket) Example: example The bucket (client) name |
page_size | integer Default: 250 |
page | integer Default: 1 |
{- "bookings": [
- {
- "booking_type": "string",
- "cancelled": true,
- "capacity": 0,
- "category": "string",
- "catering": true,
- "controller": "string",
- "date_range": "string",
- "description": "string",
- "display_value": "string",
- "end_date": "2020-01-01",
- "end_datetime": "2023-09-05T11:27:06.437000",
- "end_time": "11:27",
- "eventbrite_id": "string",
- "eventbrite_last_sync": "2023-09-05T11:27:06.437000",
- "external_boxoffice_link": "https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg",
- "formatted_title": "string",
- "group": [
- {
- "display_value": "string",
- "ref": "/example/person/6305f074683e800f3abe809e/"
}
], - "is_sold_out": true,
- "location": "string",
- "location_address_string": "string",
- "location_country": "string",
- "location_postal_code": "string",
- "record_state": "string",
- "series_id": "string",
- "start_date": "2020-01-01",
- "start_datetime": "2023-09-05T11:27:06.437000",
- "start_time": "11:27",
- "status": "string",
- "subcategory": "string",
- "tags": [
- "string"
], - "ticketed_event": true,
- "title": "string",
- "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "user_interface": {
- "can_create_booking": true,
- "can_delete_booking": true,
- "can_edit_booking": true,
- "can_restore_booking": true,
- "policy_name": "string"
}, - "waitlist_available": true,
}
]
}
All events by their status
bucket required | string (bucket) Example: example The bucket (client) name |
state required | string Enum: "all" "current" "draft" "future" "past" "running" the state or classification |
page_size | integer Default: 250 |
page | integer Default: 1 |
{- "bookings": [
- {
- "booking_type": "string",
- "cancelled": true,
- "capacity": 0,
- "category": "string",
- "catering": true,
- "controller": "string",
- "date_range": "string",
- "description": "string",
- "display_value": "string",
- "end_date": "2020-01-01",
- "end_datetime": "2023-09-05T11:27:06.437000",
- "end_time": "11:27",
- "eventbrite_id": "string",
- "eventbrite_last_sync": "2023-09-05T11:27:06.437000",
- "external_boxoffice_link": "https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg",
- "formatted_title": "string",
- "group": [
- {
- "display_value": "string",
- "ref": "/example/person/6305f074683e800f3abe809e/"
}
], - "is_sold_out": true,
- "location": "string",
- "location_address_string": "string",
- "location_country": "string",
- "location_postal_code": "string",
- "record_state": "string",
- "series_id": "string",
- "start_date": "2020-01-01",
- "start_datetime": "2023-09-05T11:27:06.437000",
- "start_time": "11:27",
- "status": "string",
- "subcategory": "string",
- "tags": [
- "string"
], - "ticketed_event": true,
- "title": "string",
- "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "user_interface": {
- "can_create_booking": true,
- "can_delete_booking": true,
- "can_edit_booking": true,
- "can_restore_booking": true,
- "policy_name": "string"
}, - "waitlist_available": true,
}
]
}
All the details for an event
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
{- "booking_type": "string",
- "cancelled": true,
- "capacity": 0,
- "category": "string",
- "catering": true,
- "controller": "string",
- "date_range": "string",
- "description": "string",
- "display_value": "string",
- "end_date": "2020-01-01",
- "end_datetime": "2023-09-05T11:27:06.437000",
- "end_time": "11:27",
- "eventbrite_id": "string",
- "eventbrite_last_sync": "2023-09-05T11:27:06.437000",
- "external_boxoffice_link": "https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg",
- "formatted_title": "string",
- "group": [
- {
- "display_value": "string",
- "ref": "/example/person/6305f074683e800f3abe809e/"
}
], - "is_sold_out": true,
- "location": "string",
- "location_address_string": "string",
- "location_country": "string",
- "location_postal_code": "string",
- "record_state": "string",
- "series_id": "string",
- "start_date": "2020-01-01",
- "start_datetime": "2023-09-05T11:27:06.437000",
- "start_time": "11:27",
- "status": "string",
- "subcategory": "string",
- "tags": [
- "string"
], - "ticketed_event": true,
- "title": "string",
- "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "user_interface": {
- "can_create_booking": true,
- "can_delete_booking": true,
- "can_edit_booking": true,
- "can_restore_booking": true,
- "policy_name": "string"
}, - "waitlist_available": true,
}
Reduced fields for faster API call and for accounts without access to the full event details
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
{- "booking_type": "string",
- "cancelled": true,
- "capacity": 0,
- "category": "string",
- "catering": true,
- "controller": "string",
- "date_range": "string",
- "description": "string",
- "display_value": "string",
- "end_date": "2020-01-01",
- "end_datetime": "2023-09-05T11:27:06.437000",
- "end_time": "11:27",
- "eventbrite_id": "string",
- "eventbrite_last_sync": "2023-09-05T11:27:06.437000",
- "external_boxoffice_link": "https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg",
- "formatted_title": "string",
- "group": [
- {
- "display_value": "string",
- "ref": "/example/person/6305f074683e800f3abe809e/"
}
], - "is_sold_out": true,
- "location": "string",
- "location_address_string": "string",
- "location_country": "string",
- "location_postal_code": "string",
- "record_state": "string",
- "series_id": "string",
- "start_date": "2020-01-01",
- "start_datetime": "2023-09-05T11:27:06.437000",
- "start_time": "11:27",
- "status": "string",
- "subcategory": "string",
- "tags": [
- "string"
], - "ticketed_event": true,
- "title": "string",
- "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "user_interface": {
- "can_create_booking": true,
- "can_delete_booking": true,
- "can_edit_booking": true,
- "can_restore_booking": true,
- "policy_name": "string"
}, - "waitlist_available": true,
}
All the attendees for an event Aliased as /events/v2/{bucket}/bookings/{uid}/attendance
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
{- "booking": {
- "booking_type": "string",
- "cancelled": true,
- "capacity": 0,
- "category": "string",
- "catering": true,
- "controller": "string",
- "date_range": "string",
- "description": "string",
- "display_value": "string",
- "end_date": "2020-01-01",
- "end_datetime": "2023-09-05T11:27:06.437000",
- "end_time": "11:27",
- "eventbrite_id": "string",
- "eventbrite_last_sync": "2023-09-05T11:27:06.437000",
- "external_boxoffice_link": "https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg",
- "formatted_title": "string",
- "group": [
- {
- "display_value": "string",
- "ref": "/example/person/6305f074683e800f3abe809e/"
}
], - "is_sold_out": true,
- "location": "string",
- "location_address_string": "string",
- "location_country": "string",
- "location_postal_code": "string",
- "record_state": "string",
- "series_id": "string",
- "start_date": "2020-01-01",
- "start_datetime": "2023-09-05T11:27:06.437000",
- "start_time": "11:27",
- "status": "string",
- "subcategory": "string",
- "tags": [
- "string"
], - "ticketed_event": true,
- "title": "string",
- "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "user_interface": {
- "can_create_booking": true,
- "can_delete_booking": true,
- "can_edit_booking": true,
- "can_restore_booking": true,
- "policy_name": "string"
}, - "waitlist_available": true,
}, - "booking_uri": "/example/person/6305f074683e800f3abe809e/",
- "sessions": [
- {
- "attendee_email": "bob@example.com",
- "attendee_name": "string",
- "created": "2023-09-05T11:27:06.437000",
- "display_value": "string",
- "guest": true,
- "guest_ref": "/example/person/6305f074683e800f3abe809e/",
- "last_updated": "2023-09-05T11:27:06.437000",
- "person_ref": "/example/person/6305f074683e800f3abe809e/",
- "record_state": "string",
- "status": "string",
- "ticket": "string",
- "ticket_ref": "/example/person/6305f074683e800f3abe809e/",
- "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/"
}
]
}
Set the attendance status for a single attendee
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
person_uri required | string (uri) Example: person_uri=/example/person/6305f074683e800f3abe809e/ The URI of the person |
status required | string Enum: "invited" "accepted" "declined" "attended" "no-show" Example: status=attended the attendance status |
{- "attendance": [
- {
- "attendance": {
- "attendee_email": "bob@example.com",
- "attendee_name": "string",
- "booking_ref": {
- "display_value": "string",
- "ref": "/example/person/6305f074683e800f3abe809e/"
}, - "guest": true,
- "legacy_uid": 1234567890,
- "person_ref": {
- "display_value": "string",
- "ref": "/example/person/6305f074683e800f3abe809e/"
}, - "status": "string",
- "ticket_ref": "/example/person/6305f074683e800f3abe809e/"
}, - "uri": "string"
}
], - "booking_ref": "/example/person/6305f074683e800f3abe809e/",
- "person_ref": "/example/person/6305f074683e800f3abe809e/",
- "status": "string"
}
All the attendees for an event Aliased as /events/v2/{bucket}/bookings/{uid}/attendance
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
{- "booking": {
- "booking_type": "string",
- "cancelled": true,
- "capacity": 0,
- "category": "string",
- "catering": true,
- "controller": "string",
- "date_range": "string",
- "description": "string",
- "display_value": "string",
- "end_date": "2020-01-01",
- "end_datetime": "2023-09-05T11:27:06.437000",
- "end_time": "11:27",
- "eventbrite_id": "string",
- "eventbrite_last_sync": "2023-09-05T11:27:06.437000",
- "external_boxoffice_link": "https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg",
- "formatted_title": "string",
- "group": [
- {
- "display_value": "string",
- "ref": "/example/person/6305f074683e800f3abe809e/"
}
], - "is_sold_out": true,
- "location": "string",
- "location_address_string": "string",
- "location_country": "string",
- "location_postal_code": "string",
- "record_state": "string",
- "series_id": "string",
- "start_date": "2020-01-01",
- "start_datetime": "2023-09-05T11:27:06.437000",
- "start_time": "11:27",
- "status": "string",
- "subcategory": "string",
- "tags": [
- "string"
], - "ticketed_event": true,
- "title": "string",
- "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "user_interface": {
- "can_create_booking": true,
- "can_delete_booking": true,
- "can_edit_booking": true,
- "can_restore_booking": true,
- "policy_name": "string"
}, - "waitlist_available": true,
}, - "booking_uri": "/example/person/6305f074683e800f3abe809e/",
- "sessions": [
- {
- "attendee_email": "bob@example.com",
- "attendee_name": "string",
- "created": "2023-09-05T11:27:06.437000",
- "display_value": "string",
- "guest": true,
- "guest_ref": "/example/person/6305f074683e800f3abe809e/",
- "last_updated": "2023-09-05T11:27:06.437000",
- "person_ref": "/example/person/6305f074683e800f3abe809e/",
- "record_state": "string",
- "status": "string",
- "ticket": "string",
- "ticket_ref": "/example/person/6305f074683e800f3abe809e/",
- "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/"
}
]
}
Get all the ticket types available for a specific event
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
{- "available_tickets": [
- {
- "access_code": "string",
- "allocated": 0,
- "amount": "123.45",
- "available": 0,
- "available_from_date": { },
- "currency": "gbp",
- "description": "string",
- "member_only": true,
- "name": "string",
- "number_of_attendees_per_ticket": "123.45",
- "pricing": "string",
- "reserved": 0,
- "single_use": true,
- "sort_order": 1,
- "tags": [
- "string"
], - "tax": "string",
- "total": 0,
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "xero_account_code": "string"
}
]
}
All the orders for an event for a booking
Requires booking.orders
permission
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
{- "booking": {
- "booking_type": "string",
- "cancelled": true,
- "capacity": 0,
- "category": "string",
- "catering": true,
- "controller": "string",
- "date_range": "string",
- "description": "string",
- "display_value": "string",
- "end_date": "2020-01-01",
- "end_datetime": "2023-09-05T11:27:06.437000",
- "end_time": "11:27",
- "eventbrite_id": "string",
- "eventbrite_last_sync": "2023-09-05T11:27:06.437000",
- "external_boxoffice_link": "https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg",
- "formatted_title": "string",
- "group": [
- {
- "display_value": "string",
- "ref": "/example/person/6305f074683e800f3abe809e/"
}
], - "is_sold_out": true,
- "location": "string",
- "location_address_string": "string",
- "location_country": "string",
- "location_postal_code": "string",
- "record_state": "string",
- "series_id": "string",
- "start_date": "2020-01-01",
- "start_datetime": "2023-09-05T11:27:06.437000",
- "start_time": "11:27",
- "status": "string",
- "subcategory": "string",
- "tags": [
- "string"
], - "ticketed_event": true,
- "title": "string",
- "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "user_interface": {
- "can_create_booking": true,
- "can_delete_booking": true,
- "can_edit_booking": true,
- "can_restore_booking": true,
- "policy_name": "string"
}, - "waitlist_available": true,
}, - "booking_uri": "/example/person/6305f074683e800f3abe809e/",
- "buyers": {
- "/example/person/12dd1259/": {
- "attendee_count": 0,
- "buyer": "/example/person/6305f074683e800f3abe809e/",
- "buyer_index_name": "string",
- "currencies": [
- "gbp"
], - "order_date": "2023-09-05T11:27:06.437000",
- "order_total": {
- "gbp": {
- "fully_paid": true,
- "outstanding": 0,
- "paid": 0,
- "processing_fees": 0,
- "total": 0
}, - "eur": {
- "fully_paid": true,
- "outstanding": 0,
- "paid": 0,
- "processing_fees": 0,
- "total": 0
}, - "usd": {
- "fully_paid": true,
- "outstanding": 0,
- "paid": 0,
- "processing_fees": 0,
- "total": 0
}
}, - "tickets": 0,
- "tickets_as_string": "string"
}
}, - "number_of_orders": 0,
- "number_of_unpaid_orders": 0
}
All the orders for an event for a specific contact
Requires contact.orders
permission
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
{- "buyer": "/example/person/6305f074683e800f3abe809e/",
- "orders": [
- {
- "booking_display": "string",
- "booking_uri": "/example/person/6305f074683e800f3abe809e/"
}
]
}
Get all the ticket for a specific event
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
{- "booking": {
- "booking_type": "string",
- "cancelled": true,
- "capacity": 0,
- "category": "string",
- "catering": true,
- "controller": "string",
- "date_range": "string",
- "description": "string",
- "display_value": "string",
- "end_date": "2020-01-01",
- "end_datetime": "2023-09-05T11:27:06.437000",
- "end_time": "11:27",
- "eventbrite_id": "string",
- "eventbrite_last_sync": "2023-09-05T11:27:06.437000",
- "external_boxoffice_link": "https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg",
- "formatted_title": "string",
- "group": [
- {
- "display_value": "string",
- "ref": "/example/person/6305f074683e800f3abe809e/"
}
], - "is_sold_out": true,
- "location": "string",
- "location_address_string": "string",
- "location_country": "string",
- "location_postal_code": "string",
- "record_state": "string",
- "series_id": "string",
- "start_date": "2020-01-01",
- "start_datetime": "2023-09-05T11:27:06.437000",
- "start_time": "11:27",
- "status": "string",
- "subcategory": "string",
- "tags": [
- "string"
], - "ticketed_event": true,
- "title": "string",
- "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "user_interface": {
- "can_create_booking": true,
- "can_delete_booking": true,
- "can_edit_booking": true,
- "can_restore_booking": true,
- "policy_name": "string"
}, - "waitlist_available": true,
}, - "booking_uri": "/example/person/6305f074683e800f3abe809e/",
- "tickets": [
- {
- "activity": "string",
- "amount": 0,
- "booking": "/example/person/6305f074683e800f3abe809e/",
- "booking_display": "string",
- "buyer": "/example/person/6305f074683e800f3abe809e/",
- "buyer_display": "string",
- "created": "2023-09-05T11:27:06.437000",
- "currency": "gbp",
- "date": "2023-09-05T11:27:06.437000",
- "display_value": "string",
- "formatted_title": "string",
- "last_updated": "2023-09-05T11:27:06.437000",
- "legacy_uid": "string",
- "number_of_attendees": 0,
- "purchase_date": "2023-09-05T11:27:06.437000",
- "quantity": 0,
- "record_state": "string",
- "reference": null,
- "tax_rate": 0,
- "ticket_id": "string",
- "ticket_type": "/example/person/6305f074683e800f3abe809e/",
- "ticket_type_display": "string",
- "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "venue": "string",
- "xero_account_code": "string"
}
]
}
A specific order for an event
Requires event.order
permission
bucket required | string (bucket) Example: example The bucket (client) name |
resource_type required | string (resource_type) Example: person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
uid required | string (uid) Example: 6305f074683e800f3abe809e The resource UID, usually a person UID |
euid required | string (uid) Example: 6305f074683e800f3abe809e The event UID |
{- "attendee_count": 0,
- "buyer": "/example/person/6305f074683e800f3abe809e/",
- "buyer_index_name": "string",
- "currencies": [
- "gbp"
], - "order_date": "2023-09-05T11:27:06.437000",
- "order_total": {
- "gbp": {
- "fully_paid": true,
- "outstanding": 0,
- "paid": 0,
- "processing_fees": 0,
- "total": 0
}, - "eur": {
- "fully_paid": true,
- "outstanding": 0,
- "paid": 0,
- "processing_fees": 0,
- "total": 0
}, - "usd": {
- "fully_paid": true,
- "outstanding": 0,
- "paid": 0,
- "processing_fees": 0,
- "total": 0
}
}, - "tickets": 0,
- "tickets_as_string": "string"
}
Deleted a specific, single order for an event
Requires event.order
permission
bucket required | string (bucket) Example: example The bucket (client) name |
resource_type required | string (resource_type) Example: person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
uid required | string (uid) Example: 6305f074683e800f3abe809e The resource UID, usually a person UID |
euid required | string (uid) Example: 6305f074683e800f3abe809e The event UID |
{- "booking_uri": "/example/person/6305f074683e800f3abe809e/",
- "contact_uri": "/example/person/6305f074683e800f3abe809e/",
- "deleted": [
- "/example/person/6305f074683e800f3abe809e/"
], - "errors": [
- "string"
], - "returned_stock": [
- "/example/person/6305f074683e800f3abe809e/"
]
}
The questions and answers submitted for this order
Requires event.order
permission
bucket required | string (bucket) Example: example The bucket (client) name |
resource_type required | string (resource_type) Example: person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
uid required | string (uid) Example: 6305f074683e800f3abe809e The resource UID, usually a person UID |
euid required | string (uid) Example: 6305f074683e800f3abe809e The event UID |
{- "booking_uri": "/example/person/6305f074683e800f3abe809e/",
- "booking_display_value": "string",
- "buyer_uri": "/example/person/6305f074683e800f3abe809e/",
- "responses": [
- {
- "contact_display_value": "string",
- "contact_uri": "/example/person/6305f074683e800f3abe809e/",
- "response": {
- "flat": { },
- "sections": [
- {
- "feedback_on": true,
- "internal_comments_on": true,
- "intro": "string",
- "marks": 0,
- "questions": [
- {
- "answer": "string",
- "core_field": true,
- "core_field_update_policy": "overwrite",
- "disabled": true,
- "field": "boolean",
- "formType": "string",
- "form_type": "string",
- "fully_qualified_field": "string",
- "helper_text": "string",
- "label": "string",
- "marks_available": 0,
- "max_word_limit": 0,
- "min_word_limit": 0,
- "options": [
- "string"
], - "original_field": "string",
- "question_uri": "/example/person/6305f074683e800f3abe809e/",
- "required": true,
- "visibility": "applicant"
}
], - "ref": "string",
- "scoring": true,
- "section_uri": "/example/person/6305f074683e800f3abe809e/",
- "subtitle": "string",
- "title": "string"
}
], - "simple": [
- {
- "answer": "string",
- "form_type": "string",
- "marks_available": 0,
- "question": "string",
- "required": true,
- "uri": "/example/person/6305f074683e800f3abe809e/"
}
]
}, - "role": "attendee",
- "uri": "/example/person/6305f074683e800f3abe809e/"
}
]
}
Get all the ticket for a specific event
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
{- "booking": {
- "booking_type": "string",
- "cancelled": true,
- "capacity": 0,
- "category": "string",
- "catering": true,
- "controller": "string",
- "date_range": "string",
- "description": "string",
- "display_value": "string",
- "end_date": "2020-01-01",
- "end_datetime": "2023-09-05T11:27:06.437000",
- "end_time": "11:27",
- "eventbrite_id": "string",
- "eventbrite_last_sync": "2023-09-05T11:27:06.437000",
- "external_boxoffice_link": "https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg",
- "formatted_title": "string",
- "group": [
- {
- "display_value": "string",
- "ref": "/example/person/6305f074683e800f3abe809e/"
}
], - "is_sold_out": true,
- "location": "string",
- "location_address_string": "string",
- "location_country": "string",
- "location_postal_code": "string",
- "record_state": "string",
- "series_id": "string",
- "start_date": "2020-01-01",
- "start_datetime": "2023-09-05T11:27:06.437000",
- "start_time": "11:27",
- "status": "string",
- "subcategory": "string",
- "tags": [
- "string"
], - "ticketed_event": true,
- "title": "string",
- "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "user_interface": {
- "can_create_booking": true,
- "can_delete_booking": true,
- "can_edit_booking": true,
- "can_restore_booking": true,
- "policy_name": "string"
}, - "waitlist_available": true,
}, - "booking_uri": "/example/person/6305f074683e800f3abe809e/",
- "tickets": [
- {
- "activity": "string",
- "amount": 0,
- "booking": "/example/person/6305f074683e800f3abe809e/",
- "booking_display": "string",
- "buyer": "/example/person/6305f074683e800f3abe809e/",
- "buyer_display": "string",
- "created": "2023-09-05T11:27:06.437000",
- "currency": "gbp",
- "date": "2023-09-05T11:27:06.437000",
- "display_value": "string",
- "formatted_title": "string",
- "last_updated": "2023-09-05T11:27:06.437000",
- "legacy_uid": "string",
- "number_of_attendees": 0,
- "purchase_date": "2023-09-05T11:27:06.437000",
- "quantity": 0,
- "record_state": "string",
- "reference": null,
- "tax_rate": 0,
- "ticket_id": "string",
- "ticket_type": "/example/person/6305f074683e800f3abe809e/",
- "ticket_type_display": "string",
- "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "venue": "string",
- "xero_account_code": "string"
}
]
}
Get the extra settings for a membership plan
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
Add an additional user input field to a membership plan
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
label required | string The label for the field that will be shown to the user |
field | string The field name, if not provided the label will be slugified |
description required | string A description of the field, shown to the user |
form_type required | string Enum: "checkbox" "date" "email" "number" "person_record" "select" "tel" "text" "textarea" The type of field |
required | boolean Is this field required? |
options | Array of strings If the form_type is select, this is the list of options that will be shown to the user |
dob_required | boolean If the form_type is person_record, is the date of birth required? |
Remove an additional user input field from a membership plan
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
field required | string The field name to be removed |
Add a condition to a membership plan e.g. Age: Under 18
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
key required | string The key element of the condition |
value required | string The value element of the condition |
Remove a condition from a membership plan
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
key required | string The key element of the condition |
Request a sync with a partner
bucket required | string (bucket) Example: example The bucket (client) name |
partner required | string Enum: "clio" "gocardless" "mailchimp" "mryum" "stripe" The partner to sync with e.g. mailchimp, gocardless, stripe |
action required | string Enum: "pull" "push" The action to perform e.g. pull, push |
data_type required | string Enum: "contacts" "consents" "payments" The data type to sync e.g. contacts, payments |
since_hours | integer Default: 24 The number of hours to look back for changes e.g. 24 would look back 24 hours for changes |
create_contacts | boolean If the data_type is contacts, should new contacts be created? |
full | boolean Where supported a full sync will override the since_hours parameter |
{- "action": "string",
- "data_type": "string",
- "function_name": "string",
- "params": {
- "bucket": "string",
- "lambda_prefix": "string",
- "safe_mode": true,
- "since_hours": 0
}, - "partner": "string",
- "status": "string"
}
Request a sync with a partner
bucket required | string (bucket) Example: example The bucket (client) name |
partner required | string Enum: "clio" "gocardless" "mailchimp" "mryum" "stripe" The partner to sync with e.g. mailchimp, gocardless, stripe |
action required | string Enum: "pull" "push" The action to perform e.g. pull, push |
data_type required | string Enum: "contacts" "consents" "payments" The data type to sync e.g. contacts, payments |
since_hours | integer Default: 24 The number of hours to look back for changes e.g. 24 would look back 24 hours for changes |
create_contacts | boolean If the data_type is contacts, should new contacts be created? |
full | boolean Where supported a full sync will override the since_hours parameter |
{- "action": "string",
- "data_type": "string",
- "function_name": "string",
- "params": {
- "bucket": "string",
- "lambda_prefix": "string",
- "safe_mode": true,
- "since_hours": 0
}, - "partner": "string",
- "status": "string"
}
A single master invoice or statement record containing the details of the invoice, client config data and payment details
bucket required | string (bucket) Example: example The bucket (client) name |
invoice_type required | string (invoice_type) Enum: "order" "invoice" "membership" Example: order The type of invoice |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
{- "billing_contact": "/example/person/6305f074683e800f3abe809e/",
- "buyer": {
- "buyer_address": [
- "1 High Street",
- "Oxford",
- "Oxfordshire",
- "OX1 1AA"
], - "buyer_country": "string",
- "buyer_email": "bob@example.com",
- "buyer_locality": "Oxford",
- "buyer_name": "string",
- "buyer_postal_code": "SW1A 1AA",
- "buyer_region": "Oxfordshire",
- "buyer_telephone": "01234 567890",
- "buyer_vat_number": "string"
}, - "buyer_ref": "/example/person/6305f074683e800f3abe809e/",
- "config": {
- "address": [
- "1 High Street",
- "Oxford",
- "Oxfordshire",
- "OX1 1AA"
], - "contact_details": "string",
- "contact_email": "string",
- "contact_phone": "string",
- "default_currency": "gbp",
- "flock_name": "string",
- "payment_detail_notes": "string",
- "payment_details": "string",
- "postal_code": "string",
- "purchase_order_string": "string",
- "tax_name": "string",
- "template": "string",
- "vat_number": "string"
}, - "context": "/example/person/6305f074683e800f3abe809e/",
- "currency": "string",
- "date": "2020-01-01",
- "due": 0,
- "for_the_attention_of": "string",
- "id": "string",
- "invoice_currency": "gbp",
- "invoice_uri": "/example/person/6305f074683e800f3abe809e/",
- "line_items": [
- {
- "currency": "gbp",
- "name": "string",
- "price": 0,
- "quantity": 0,
- "ref": "/example/person/6305f074683e800f3abe809e/",
- "tax": "standard",
- "tax_rate": 0,
- "tax_total": 0,
- "tax_total_float": 0,
- "total": 0,
- "total_before_tax": 0,
- "total_float": 0,
- "xero_account_code": "string"
}
], - "links": [
- {
- "filename": "string",
- "prompt": "string",
- "rel": "string"
}
], - "number_of_payments": 0,
- "payment_reference_uri": "/example/person/6305f074683e800f3abe809e/",
- "purchase_order_no": "string",
- "signature": "6305f",
- "signed_invoice_uri": "/example/person/6305f074683e800f3abe809e/",
- "status": "string",
- "tax_total": 0,
- "total": 0,
- "total_before_tax": 0,
- "total_paid": 0,
- "total_scheduled": 0,
- "total_tax": 0,
- "xero_ready": true
}
A single master invoice or statement record containing the details of the invoice, client config data and payment details
bucket required | string (bucket) Example: example The bucket (client) name |
invoice_type required | string (invoice_type) Enum: "order" "invoice" "membership" Example: order The type of invoice |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
signature required | string (signature) Example: 6305f An alphanumeric string that is used to verify the request |
{- "billing_contact": "/example/person/6305f074683e800f3abe809e/",
- "buyer": {
- "buyer_address": [
- "1 High Street",
- "Oxford",
- "Oxfordshire",
- "OX1 1AA"
], - "buyer_country": "string",
- "buyer_email": "bob@example.com",
- "buyer_locality": "Oxford",
- "buyer_name": "string",
- "buyer_postal_code": "SW1A 1AA",
- "buyer_region": "Oxfordshire",
- "buyer_telephone": "01234 567890",
- "buyer_vat_number": "string"
}, - "buyer_ref": "/example/person/6305f074683e800f3abe809e/",
- "config": {
- "address": [
- "1 High Street",
- "Oxford",
- "Oxfordshire",
- "OX1 1AA"
], - "contact_details": "string",
- "contact_email": "string",
- "contact_phone": "string",
- "default_currency": "gbp",
- "flock_name": "string",
- "payment_detail_notes": "string",
- "payment_details": "string",
- "postal_code": "string",
- "purchase_order_string": "string",
- "tax_name": "string",
- "template": "string",
- "vat_number": "string"
}, - "context": "/example/person/6305f074683e800f3abe809e/",
- "currency": "string",
- "date": "2020-01-01",
- "due": 0,
- "for_the_attention_of": "string",
- "id": "string",
- "invoice_currency": "gbp",
- "invoice_uri": "/example/person/6305f074683e800f3abe809e/",
- "line_items": [
- {
- "currency": "gbp",
- "name": "string",
- "price": 0,
- "quantity": 0,
- "ref": "/example/person/6305f074683e800f3abe809e/",
- "tax": "standard",
- "tax_rate": 0,
- "tax_total": 0,
- "tax_total_float": 0,
- "total": 0,
- "total_before_tax": 0,
- "total_float": 0,
- "xero_account_code": "string"
}
], - "links": [
- {
- "filename": "string",
- "prompt": "string",
- "rel": "string"
}
], - "number_of_payments": 0,
- "payment_reference_uri": "/example/person/6305f074683e800f3abe809e/",
- "purchase_order_no": "string",
- "signature": "6305f",
- "signed_invoice_uri": "/example/person/6305f074683e800f3abe809e/",
- "status": "string",
- "tax_total": 0,
- "total": 0,
- "total_before_tax": 0,
- "total_paid": 0,
- "total_scheduled": 0,
- "total_tax": 0,
- "xero_ready": true
}
Get all notifications for the user ordered by date (new -> old)
bucket required | string (bucket) Example: example The bucket (client) name |
page_size | integer Default: 7 |
{- "notification": {
- "assigned_to": "string",
- "assigned_to_display": "string",
- "body": "string",
- "context": "string",
- "context_display": "string",
- "created": "string",
- "creator": "string",
- "creator_reference": "string",
- "date": "string",
- "display_value": "string",
- "entity": "string",
- "entry_subtype": "string",
- "entry_type": "string",
- "files": [
- "string"
], - "last_updated": "string",
- "link": "string",
- "record_state": "string",
- "star": true,
- "tags": [
- "string"
], - "text_body": "string",
- "title": "string",
- "uid": "string",
- "uri": "string",
- "user_interface": {
- "can_create_journal": true,
- "can_delete_journal": true,
- "can_edit_journal": true,
- "can_restore_journal": true,
- "policy_name": "string"
}
}
}
Get a single notification
bucket required | string (bucket) Example: example The bucket (client) name |
resource_type required | string (resource_type) Example: person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
Mark a single notification as complete
bucket required | string (bucket) Example: example The bucket (client) name |
resource_type required | string (resource_type) Example: person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
Snooze a single notification for 24 hours or for 24 hours from now if overdue.
bucket required | string (bucket) Example: example The bucket (client) name |
resource_type required | string (resource_type) Example: person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
Segments are groups of records that can be used for browsing or bulk actions. This endpoint returns a list of all the active segments in the system.
bucket required | string (bucket) Example: example The bucket (client) name |
page_size | number (page_size) Example: page_size=10 The number of items to return per page, usually used in conjunction with |
page | number (page) Example: page=1 A page number, usually used in conjunction with |
{- "segments": [
- {
- "active": true,
- "created": "2023-09-05T11:27:06.437000",
- "description": "string",
- "display_value": "string",
- "last_updated": "2023-09-05T11:27:06.437000",
- "legacy_uid": "string",
- "mailchimp_sync": true,
- "name": "string",
- "parent_segment": "string",
- "record_state": "string",
- "resource_type": "person",
- "rules": { },
- "segment_type": "string",
- "system_segment": true,
- "tags": [
- "string"
], - "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "uris_exclude": [
- "/example/person/6305f074683e800f3abe809e/"
], - "uris_include": [
- "/example/person/6305f074683e800f3abe809e/"
], - "user_interface": {
- "can_create_segment": true,
- "can_delete_segment": true,
- "can_edit_segment": true,
- "can_restore_segment": true,
- "policy_name": "string"
}, - "view_context": [
- "string"
]
}
]
}
A list of all the segments in the system including inactive segments.
bucket required | string (bucket) Example: example The bucket (client) name |
page_size | number (page_size) Example: page_size=10 The number of items to return per page, usually used in conjunction with |
page | number (page) Example: page=1 A page number, usually used in conjunction with |
{- "segments": [
- {
- "active": true,
- "created": "2023-09-05T11:27:06.437000",
- "description": "string",
- "display_value": "string",
- "last_updated": "2023-09-05T11:27:06.437000",
- "legacy_uid": "string",
- "mailchimp_sync": true,
- "name": "string",
- "parent_segment": "string",
- "record_state": "string",
- "resource_type": "person",
- "rules": { },
- "segment_type": "string",
- "system_segment": true,
- "tags": [
- "string"
], - "uid": "6305f074683e800f3abe809e",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "uris_exclude": [
- "/example/person/6305f074683e800f3abe809e/"
], - "uris_include": [
- "/example/person/6305f074683e800f3abe809e/"
], - "user_interface": {
- "can_create_segment": true,
- "can_delete_segment": true,
- "can_edit_segment": true,
- "can_restore_segment": true,
- "policy_name": "string"
}, - "view_context": [
- "string"
]
}
]
}
Request a bulk action to be performed on all the records in a segment.
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
action required | string Enum: "add_tag" "change-status" "debug" "draft-templated-email" "join-group" "raise-authorised-xero-invoice" "raise-draft-xero-invoice" "raise-submitted-xero-invoice" "remove_tag" "send-email-to-fixed-address" "send-json-webhook" "send-templated-email" "send-templated-email-request-acknowledgement" "send-templated-in-app-message" "send-templated-in-app-message-request-acknowledgement" "send-templated-sms" "send-webhook" "set-single-field" "set-single-field-on-last-membership" |
value required | string The value to be used in the action. This is dependent on the action. |
description required | string A description of the action to be performed. This is used in the audit trail. |
field | string The field to be used in the action. This is dependent on the action and required by some actions. |
{- "action": "/example/person/6305f074683e800f3abe809e/",
- "description": "string",
- "field": "string",
- "segment_uri": "/example/person/6305f074683e800f3abe809e/",
- "sheep_event": "/example/person/6305f074683e800f3abe809e/",
- "status": "created",
- "user_uri": "/sheepcrm/user/6305f074683e800f3abe809e/",
- "value": "string",
- "verbose": false
}
The config for a segment
bucket required | string (bucket) Example: example The bucket (client) name |
resource_type required | string (resource_type) Example: person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
{- "mapping": {
- "collection": "string",
- "contact_field": null,
- "contact_search_fields": [
- null
], - "field_list": [
- "string"
], - "fields": [
- {
- "field": "string",
- "form_type": "string",
- "label": "string",
- "style": "string"
}
], - "join_orgs": true,
- "join_people": true,
- "name": "string",
- "name_singular": "string",
- "prefix": "string",
- "search_fields": [
- "string"
], - "search_placeholder": "string",
- "sort_by": [
- "string"
], - "unique_field": "string",
- "use_mapreduce": true
}, - "resource_type": "string",
- "segment": "/example/person/6305f074683e800f3abe809e/",
- "segment_type": "dynamic",
- "user_groups": [
- null
], - "user_groups_for_display": [
- null
], - "user_interface": {
- "can_bypass_gdpr": [
- true
], - "can_create_segment": true,
- "can_delete_segment": true,
- "can_edit_segment": true,
- "can_restore_segment": true
}, - "view_context": [
- "string"
]
}
The count and description of the segment
bucket required | string (bucket) Example: example The bucket (client) name |
resource_type required | string (resource_type) Example: person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
{- "count": 0,
- "description": "string",
- "segment": "/example/person/6305f074683e800f3abe809e/"
}
Lookup a record within a segment using a simple single search term
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
q | string (uid) Example: q=6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
[- {
- "display_value": "string",
- "id": "/example/person/6305f074683e800f3abe809e/",
- "label": "string",
- "text": "string",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "value": "/example/person/6305f074683e800f3abe809e/"
}
]
Segments are groups of records that can be used for browsing or bulk actions. This endpoint returns a list of all the records in the segment.
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
q | string (q) Example: q=john smith |
page_size | number (page_size) Example: page_size=10 The number of items to return per page, usually used in conjunction with |
page | number (page) Example: page=1 A page number, usually used in conjunction with |
verbose | boolean (verbose) Example: verbose=true A boolean value that can be used to return more verbose information in a response |
Export a PDF report based on the data from the segment
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
template required | string |
policy | string |
gdpr_bypass | boolean Default: false |
gdpr_bypass_reason | string |
debug | boolean Default: false |
{- "bucket": "example",
- "uid": "6305f074683e800f3abe809e",
- "lambda_prefix": "string",
- "policy": "string",
- "gdpr_bypass": true,
- "gdpr_channel": "string",
- "user_uri": "/sheepcrm/user/6305f074683e800f3abe809e/",
- "template": "string",
- "journal_uri": "/example/person/6305f074683e800f3abe809e/",
- "use_mapreduce": true,
- "report_format": "string",
- "debug": true
}
Export a XLSX report based on the data from the segment
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
template | string |
policy | string |
gdpr_bypass | boolean Default: false |
gdpr_bypass_reason | string |
debug | boolean Default: false |
{- "bucket": "example",
- "uid": "6305f074683e800f3abe809e",
- "lambda_prefix": "string",
- "policy": "string",
- "gdpr_bypass": true,
- "gdpr_channel": "string",
- "user_uri": "/sheepcrm/user/6305f074683e800f3abe809e/",
- "template": "string",
- "journal_uri": "/example/person/6305f074683e800f3abe809e/",
- "use_mapreduce": true,
- "report_format": "string",
- "debug": true
}
Sync the segment with Mailchimp
bucket required | string (bucket) Example: example The bucket (client) name |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
segment_name | string Default: "The name of the segment" |
mailchimp_batch_size | integer Default: 500 |
verbose | boolean Default: false |
{- "bucket": "example",
- "lambda_prefix": "string",
- "segment_uri": "/example/person/6305f074683e800f3abe809e/",
- "segment_name": "string",
- "mailchimp_batch_size": 0,
- "verbose": true,
- "journal_uri": "/example/person/6305f074683e800f3abe809e/",
- "safe_mode": true
}
This endpoint returns a list of empty form responses for the given form.
bucket required | string (bucket) Example: example The bucket (client) name |
form_ref required | string (uri) Example: form_ref=/example/person/6305f074683e800f3abe809e/ URIs are unique identifiers for resources in the system,
they are structured as follows |
quantity required | integer >= 1 Default: 1 |
A printable PDF of an invoice. The template parameter is optional and defaults to sheep-invoice-a4. The standard template uses the logo, address and other settings provided for the client. Contact the support team if you would like a custom template.
bucket required | string (bucket) Example: example The bucket (client) name |
resource_type required | string (resource_type) Example: person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
signature required | string (signature) Example: 6305f An alphanumeric string that is used to verify the request |
template | string Default: "sheep-invoice-a4" |
All pages (and index pages) are accessed through a single endpoint.
The path
is a required parameter and the response will be a page config block
and zero or more resources. (A page will have just one resources, an index
page may have many.) User credentials are optional but may be required
if the page is not public or is only for members.
bucket required | string (bucket) Example: example The bucket (client) name |
path | string Example: path=archive-introduction/ The URL path (after the domain name). All paths should end with a trailing slash. |
object (page_user_query) A dictionary of query terms which are merged with the base query for the index page (if present). |
{- "page_status": "OK",
- "allowed_access": true,
- "page_type": "single",
- "resource": "string",
- "user_context": {
- "contact_uri": "/example/person/6305f074683e800f3abe809e/",
- "is_logged_in": true,
- "is_member": true,
- "user_account": {
- "email": "bob@example.com",
- "first_name": "string",
- "last_name": "string",
- "last_login_date": "2023-09-05T11:27:06.437000",
- "session_expiry": "2023-09-05T11:27:06.437000",
- "uri": "/example/person/6305f074683e800f3abe809e/",
- "username": "string"
}, - "username": "string"
}, - "page_config": {
- "active": true,
- "archive_date": "/example/person/6305f074683e800f3abe809e/",
- "body": "string",
- "fallback_body": "string",
- "filter": { },
- "legacy_uid": "string",
- "member_only": true,
- "meta": { },
- "path": "string",
- "public": true,
- "publish_date": "2020-01-01",
- "resource_type": "person",
- "secondary_photos": [
], - "table_config": null,
- "tags": [
- "string"
], - "template": "string",
- "title": "string",
- "uri": "/example/person/6305f074683e800f3abe809e/"
}, - "path_elements": { }
}
This endpoint returns a list of empty form responses for the given form.
bucket required | string (bucket) Example: example The bucket (client) name |
form_ref required | string (uri) Example: form_ref=/example/person/6305f074683e800f3abe809e/ URIs are unique identifiers for resources in the system,
they are structured as follows |
quantity required | integer >= 1 Default: 1 |
A printable PDF of an invoice. The template parameter is optional and defaults to sheep-invoice-a4. The standard template uses the logo, address and other settings provided for the client. Contact the support team if you would like a custom template.
bucket required | string (bucket) Example: example The bucket (client) name |
resource_type required | string (resource_type) Example: person The type of resource, usually the second element in the URI e.g person, organisation, member, payment |
uid required | string (uid) Example: 6305f074683e800f3abe809e Usually the final element in the URI, an alphanumeric unique identifier |
signature required | string (signature) Example: 6305f An alphanumeric string that is used to verify the request |
template | string Default: "sheep-invoice-a4" |