Get importer keys

GET /api/v1/import/keys/{importer}/{mode}

Path parameters

  • importer string Required

    the importer type to get keys for, valid types are ['plans','client','valuations']

  • mode string Required

    Optional parameter.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • keys array[string]

      List of keys for the specified importer

GET /api/v1/import/keys/{importer}/{mode}
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/import/keys/plans/{"value"=>"", "summary"=>"When the value is omitted"}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "keys": [
    "name",
    "uuid",
    "client_uuid",
    "type",
    "sub_type",
    "provider_uuid",
    "policy_number"
  ]
}