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": "5893c703-5752-4770-8c76-f4d14eb4124f",
      "created_at": "2025-01-17T11:18:33+00:00",
      "updated_at": "2025-01-17T11:18:33+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": "fdcc69c1-8dcd-4742-a4e2-f4d6f4eac5f4",
      "returnable_type": "plan",
      "returnable_uuid": "79105bd8-feb2-45fa-ab3a-f35f67b4dc9f",
      "lookupable_value": "J Bloggs Plan",
      "returnable_value": "example"
    }
  ]
}