Search Guide

The sheepCRM Search API provides several specialised search endpoints. This guide covers practical usage patterns and examples — see the sheepAPI (SLS) reference for the full endpoint specifications.

Global search

Global search queries across all primary data types (Contacts, Events, and Vehicles).

Parameter	Required	Description
q	Yes	The search string

http https://sls-api.sheepcrm.com/search/v2/example/ "Authorization: Bearer $API_KEY" q=="webster"

HTTP/1.1 200 OK
{
    "q": "webster",
    "results": [
        {
            "display_value": "Bob Webster",
            "distance": 78,
            "id": "/example/person/5cc97b9d8b38806b28cd35b6/",
            "primary_email": "bob@example.com",
            "primary_telephone": null,
            "resource": "person"
        },
        {
            "display_value": "Theo Webster",
            "distance": 74,
            "id": "/example/person/56dddf607e6ca15f518356cd/",
            "primary_email": "theo@example.com",
            "primary_telephone": null,
            "resource": "person"
        }
    ]
}

Help search

Search for help articles on a specific topic.

Parameter	Required	Description
q	Yes	The search string

http https://sls-api.sheepcrm.com/search/v2/example/help "Authorization: Bearer $API_KEY" q=="automatic emails"

HTTP/1.1 200 OK
{
    "docs": 169,
    "q": "automatic emails",
    "results": [
        {
            "link": "https://intercom.help/sheepcrm/en/articles/6161297-settings-configuring-integrations-with-sheepcrm",
            "title": "Settings: Configuring integrations with sheepCRM"
        },
        {
            "link": "https://intercom.help/sheepcrm/en/articles/1839428-what-s-new-in-sheep",
            "title": "What's new in Sheep?"
        }
    ]
}

Finding a person

The full person record is returned for a person that matches the search parameters.

Parameter	Required	Description
title	No	Person’s title e.g. `Miss`
first_name	No	Person’s first name e.g. `Jane`
last_name	No	Person’s last name e.g. `Doe`
email	No	Person’s email address e.g. `jane@example.com`
date_of_birth	No	Person’s date of birth e.g. `1980-01-31` (ISO 8601)
postal_code	No	Person’s postal code e.g. `SW1A 1AA`
take_first_if_multiple	No	Whether to return the first result if multiple results are found. Default: `false` (if multiple results are found, an error is returned)

http https://sls-api.sheepcrm.com/search/v2/example/person "Authorization: Bearer $API_KEY" email==theo@james-webster.co.uk

HTTP/1.1 200 OK
{
    "_id": null,
    "bucket": "example",
    "created": "2016-03-07T20:06:56.880000",
    "data": {
        "abilities": [],
        "address_lines": [
            null
        ],
        "adult": null,
        ...
    },
    "display_value": "Theo Webster",
    "id": "56dddf607e6ca15f518356cd",
    "last_updated": "2022-02-15T20:51:10.777000",
    "resource": "person",
    "state": "updated",
    "uri": "/example/person/56dddf607e6ca15f518356cd/"
}

Vehicle search (DVLA lookup)

Search for vehicles using optional search terms. When a registration number is provided, the API performs a DVLA lookup and returns vehicle details.

Parameter	Required	Description
registration_number	No	Car registration number e.g. `AB12 CDE`
engine_number	No	The engine number
identifying_number	No	VIN or chassis number (in older vehicles)

http https://sls-api.sheepcrm.com/search/v2/example/car "Authorization: Bearer $API_KEY" registration_number==EK11ORP

HTTP/1.1 200 OK
{
    "dvla": {
        "capacity": 1242,
        "co2_emissions": 113,
        "colour": "WHITE",
        "date_of_last_v5c_issued": "2020-11-03",
        "fuel_type": "PETROL",
        "make": "FIAT",
        "marked_for_export": false,
        "month_of_first_registration": "2011-04",
        "mot_date": "2023-10-11",
        "mot_status": "Valid",
        "registration_number": "EK11ORP",
        "tax_due_date": "2023-11-01",
        "tax_status": "Taxed",
        "type_approval": "M1",
        "wheel_plan": "2 AXLE RIGID BODY",
        "year": 2011
    }
}