Retrieve a lookup Run in API Explorer

GET /api/v1/lookups/{type}/{lookup}
Personal access token & O auth2

Try to find a Lookup value for a specific type.

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • type string Required
  • lookup string Required

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • lookupable_type string
      • lookupable_uuid string
      • lookupable_value string
      • lookup_value string
      • returnable_type string
      • returnable_uuid string
      • returnable_value string
      • return_string string
      • return_json object
        Hide return_json attributes Show return_json attributes object
        • key_1 string
        • key_2 string
      • return_float number
GET /api/v1/lookups/{type}/{lookup} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/lookups/provider_statement_mapping/architecto' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "type": "provider_statement_mapping",
      "uuid": "fe4e32c0-de5b-4f62-9ebe-91200729524c",
      "created_at": "2025-11-18T19:51:12+00:00",
      "updated_at": "2025-11-18T19:51:12+00:00",
      "return_json": {
        "key_1": "value_1",
        "key_2": "value_2"
      },
      "lookup_value": "zAbWeFVJ:Bloggs J",
      "return_float": 70.35,
      "return_string": "Consectetur officia labore",
      "lookupable_type": "provider",
      "lookupable_uuid": "36fab8e9-b876-4b07-9d8a-450e5426a220",
      "returnable_type": "plan",
      "returnable_uuid": "29a9f978-6972-4d92-8e21-1a1d646185ec",
      "lookupable_value": "J Bloggs Plan",
      "returnable_value": "example"
    }
  ]
}