Find a record by property value

Changed on

Returns the single record whose property {slug} equals {value}. 404 if nothing matches; 409 if more than one record matches.

get/v2/prism/{teamId}/contact/by/{slug}/{value}

Request

  • Base URL
    https://developers.micro.so
  • URL
    https://developers.micro.so/v2/prism/{teamId}/contact/by/{slug}/{value}
  • Auth
    API key in header x-api-key

Path parameters

teamIdstring uuid required
slugstring required

Property slug to match (e.g. email).

valuestring required

Property value to match exactly. URL-encode special characters.

Query parameters

list_idstring uuid

Scope the lookup to a specific list/app.

Response

Matched record

idstring uuid required
defaultobject

Properties keyed by property slug.

listobject

Changes