Contacts

Find a person

title:optional: title of the person e.g. Dr, Ms, Mrs, case sensitive
first_name:optional. case sensitive
last_name:optional. case sensitive
email:optional: valid email address, case insensitive
date_of_birth:optional: any reasonable date format but YYYY-MM-DD recommended
postal_code:optional: postcode / zip code, case sensitive
take_first_if_multiple:
 optional: as it suggests - if multiple matches are returned take the first (order undefined)
Matching rules:
  1. by email
  2. by first name, last name and date of birth
  3. by first name, last name and postcode
  4. by title, last name and postcode
$ http https://api.sheepcrm.com/api/v1/$FLOCK/find/person/ email==james@example.com "Authorization: Bearer $API_KEY"

$ http https://api.sheepcrm.com/api/v1/$FLOCK/find/person/ first_name==James last_name==Webster postal_code=='NR28 8FL' "Authorization: Bearer $API_KEY"

Find an organisation

name:optional. case sensitive
email:optional: valid email address, case insensitive
postal_code:optional: postcode / zip code, case sensitive
domain:optional: website domain (no http etc)
take_first_if_multiple:
 optional: as it suggests - if multiple matches are returned take the first (order undefined)
Matching rules:
  1. by name and postcode
  2. by exact name
  3. by email
  4. by domain
$ http https://api.sheepcrm.com/api/v1/$FLOCK/find/organisation/ name=='Authentic Digital Ltd' "Authorization: Bearer $API_KEY"

Get all the connections for a contact

limit:return first N connections
connection_type:
 return on connections of a specified type
hidden:include hidden connections (Y/N); hidden connections are not included by default 
$ http https://api.sheepcrm.com/api/v1/$FLOCK/connections/?uri={UID} "Authorization: Bearer $API_KEY"
HTTP/1.0 200 OK

{
    "connections": [
        {
            "automatic": null,
            "bidirectional": null,
            "connection_note": null,
            "connection_type": null,
            "destination": "/example/person/5aafb4de0490573922b9da91/",
            "end_date": null,
            "hidden": false,
            "label": "contact",
            "sort_order": 1000,
            "source": "/example/organisation/5a57701704905781f28622ac/",
            "start_date": "2019-08-20T12:30:42.523000"
        },
        ...
{