Returns referrals for the current firm with direction indicated. Run in API Explorer

GET /api/v1/referrals
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[status] string

    Filter by status. Valid values: pending, accepted, rejected, expired.

  • filter[direction] string

    Filter by direction. Valid values: sent, received.

  • sort string

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

Responses

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