Get all lookups

GET /api/v1/lookups
Personal access token & OAuth2

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]

      Additional properties are allowed.
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": "6573193b-bfc3-4afb-9479-89a79c86738c",
      "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": "8bf7d11d-e5e8-4a53-9fd5-0aa9f34ffa1e",
      "returnable_type": "plan",
      "returnable_uuid": "f86fa5e6-6435-47b1-ba3d-a9fa33318e27",
      "lookupable_value": "J Bloggs Plan",
      "returnable_value": "example"
    }
  ]
}