Retrieve a lookup

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

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 \
 --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": "f8198504-02b6-4bf8-b640-106a316e60eb",
      "created_at": "2025-02-20T10:13:06+00:00",
      "updated_at": "2025-02-20T10:13:06+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": "b449d201-9ba8-4d1b-baaf-f434e9705dad",
      "returnable_type": "plan",
      "returnable_uuid": "81dd45c0-4c0b-4d02-b97d-13920de79157",
      "lookupable_value": "J Bloggs Plan",
      "returnable_value": "example"
    }
  ]
}