GET /api/v2/plans/linked-policy-numbers
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[linked_policy_number] string

    Filter by a comma separated list of partial linked policy numbers of the linked policy numbers.

  • filter[policy_number] string

    Filter by a comma separated list of partial policy numbers of the plans the linked policy numbers belong to.

  • filter[plan_uuid] string

    Filter by a comma separated list of plan UUIDs the linked policy numbers belong to.

  • filter[provider_uuids] string

    Filter by a comma separated list provider UUIDS.

  • filter[account_uuids] string

    Filter by a comma separated list account UUIDS.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, linked_policy_number, policy_number, provider]. Negative sign to denote DESC. Defaults to '-created_at'.

  • per_page integer

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

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string
GET /api/v2/plans/linked-policy-numbers 
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/plans/linked-policy-numbers' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (401) 
{
  "message": "Unauthenticated."
}