Retrieve a lookup

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

Try to find a Lookup value for a specific type.

Path parameters

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
GET /api/v1/lookups/{type}/{lookup} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/lookups/type/lookup' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "type": "provider_statement_mapping",
      "uuid": "2ed26dd2-8a3e-4918-911f-cc5c521cc94a",
      "created_at": "2025-05-23T13:04:01+01:00",
      "updated_at": "2025-05-23T13:04:01+01: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": "95a91ffd-aaa7-4501-81dc-76d7801af8bb",
      "returnable_type": "plan",
      "returnable_uuid": "3b4e7fcd-308a-47f0-8040-6c111c0df4eb",
      "lookupable_value": "J Bloggs Plan",
      "returnable_value": "example"
    }
  ]
}