Get all lookups

GET /api/v1/lookups

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Query parameters

filter[uuid] string

Filter by a comma separated list of UUIDs.
filter[types] string

Filter by a comma separated list of lookup types.
sort string

Field to sort by. Valid fields are [created_at]. Negative sign to denote DESC. Defaults to 'created_at'.
per_page integer

Number of results to return with pagination (Default 15. Max 500).

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

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/lookups' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "type": "provider_statement_mapping",
      "uuid": "e37ac7ad-760a-46cd-8ab0-20a5ccb3b5ed",
      "created_at": "2025-09-17T15:46:53+01:00",
      "updated_at": "2025-09-17T15:46:53+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": "2bce6521-7781-46e7-8a16-dd875aa83c42",
      "returnable_type": "plan",
      "returnable_uuid": "68b8ad8f-9ff1-49b8-9e76-c52b92e3764b",
      "lookupable_value": "J Bloggs Plan",
      "returnable_value": "example"
    }
  ]
}