Skip to content
OpenGTM

Similar Leads

GET
/api/lead/{lead_id}/similar
curl --request GET \
  --url 'http://localhost:8000/api/lead/1/similar?limit=10' \
  --header 'Authorization: Bearer <token>'

Find leads similar to a given lead (by specialization, then city).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
lead_id
required
Lead Id
integer

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 10

Header Parameters

Section titled “Header Parameters”
x-workspace-id
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}