Retrieve a lookup

GET /api/v1/lookups/{type}/{lookup}

Try to find a Lookup value for a specific type.

Path parameters

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]

      Additional properties are allowed.
GET /api/v1/lookups/{type}/{lookup} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/lookups/type/lookup \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "type": "provider_statement_mapping",
      "uuid": "b735d623-45de-441b-95a7-3a18a3152375",
      "created_at": "2024-11-20T13:24:04+00:00",
      "updated_at": "2024-11-20T13:24:04+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": "7b650f7a-2b06-4aae-b9c9-265dea551ea5",
      "returnable_type": "plan",
      "returnable_uuid": "6802cf50-5468-490f-bdda-c766ce4d2b9f",
      "lookupable_value": "J Bloggs Plan",
      "returnable_value": "example"
    }
  ]
}