Headers
-
Content-Type
string -
Accept
string -
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).
GET
/api/v1/lookups
curl \
--request GET 'https://api.plannrcrm.com/api/v1/lookups' \
--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": "786eae40-35ca-4f83-80dd-2538d9a9be35",
"created_at": "2025-04-02T13:27:59+01:00",
"updated_at": "2025-04-02T13:27:59+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": "33c07c2d-eb22-4eb4-8c39-bd2c99391f12",
"returnable_type": "plan",
"returnable_uuid": "dae367ac-b39b-4b04-83d0-e9c85d780614",
"lookupable_value": "J Bloggs Plan",
"returnable_value": "example"
}
]
}