Skip to main content
POST
/
api
/
lookup
/
name
Lookup by name
curl --request POST \
  --url https://brunkhorst.connectors.aicoflow.com/api/lookup/name \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "term": "<string>",
  "limit": 15
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Request model for customer/vehicle lookups.

​
term
string
required

Search term (phone, name, or license plate)

​
limit
integer
default:15

Maximum number of results

Required range: 1 <= x <= 100

Response

List of matching customers with their details