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": [
    [
      {
        "uuid": "55f78828-a1ca-4a9a-b044-d6396feb2c1c",
        "created_at": "2026-04-29T16:54:32+01:00",
        "updated_at": "2026-04-29T16:54:32+01:00",
        "type": "provider_statement_mapping",
        "lookupable_type": "provider",
        "lookupable_uuid": "572608bf-1abe-44dd-a877-57207e7f1338",
        "lookupable_value": "J Bloggs Plan",
        "lookup_value": "zAbWeFVJ:Bloggs J",
        "returnable_type": "plan",
        "returnable_uuid": "db6c5411-248a-4c46-8fbe-72b8cb218238",
        "returnable_value": "example",
        "return_string": "Consectetur officia labore",
        "return_json": {
          "key_1": "value_1",
          "key_2": "value_2"
        },
        "return_float": 70.35
      }
    ]
  ]
}