Get api v1 referral connections referral connection uuid

Get api v1 referral connections referral connection uuid Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

GET /api/v1/referral-connections/{referralConnection_uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

referralConnection_uuid string Required

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- direction string
  
  The direction of the connection relative to the current firm. Possible values: sent, received
- status string
  
  The status of the referral connection. Possible values: pending, accepted, denied, expired
- sender_firm object
  
  The firm that sent the referral connection request
  
  Hide sender_firm attributes Show sender_firm attributes object
  
  uuid string
  
  name string
- recipient_firm object
  
  The firm that received the referral connection request
  
  Hide recipient_firm attributes Show recipient_firm attributes object
  
  uuid string
  
  name string
- sender_account object
  
  The account that sent the referral connection request
  
  Hide sender_account attributes Show sender_account attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  external_references object
  
  Hide external_references attributes Show external_references attributes object
  
  uuid
  
  The UUID of the resource.
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was updated.
  
  third_party
  
  The third party provider with the reference.
  
  reference
  
  The third party reference.
- recipient_account object
  
  The account that received the referral connection request
  
  Hide recipient_account attributes Show recipient_account attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  external_references object
  
  Hide external_references attributes Show external_references attributes object
  
  uuid
  
  The UUID of the resource.
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was updated.
  
  third_party
  
  The third party provider with the reference.
  
  reference
  
  The third party reference.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- expires_at string
  
  The datetime when the referral connection request expires

GET /api/v1/referral-connections/{referralConnection_uuid}

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/referral-connections/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "uuid": "9d0b9bf0-512b-4082-a817-44ac751ab058",
  "direction": "sent",
  "status": "pending",
  "sender_firm": {
    "uuid": "abc-123",
    "name": "Sender Firm Name"
  },
  "recipient_firm": {
    "uuid": "def-456",
    "name": "Recipient Firm Name"
  },
  "sender_account": {
    "uuid": "2bbd39fb-3a6b-42ca-985b-e6f975e63a38",
    "created_at": "2026-10-08T16:24:03+01:00",
    "updated_at": "2026-10-08T16:24:03+01:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": {
      "uuid": "e787510a-b280-4850-a22b-0274a00c9970",
      "created_at": "2026-10-08T16:24:08+01:00",
      "updated_at": "2026-10-08T16:24:08+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "recipient_account": {
    "uuid": "0d2bc6dd-18ef-49b8-b8cb-1e7332ddc255",
    "created_at": "2026-10-08T16:24:03+01:00",
    "updated_at": "2026-10-08T16:24:03+01:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": {
      "uuid": "e787510a-b280-4850-a22b-0274a00c9970",
      "created_at": "2026-10-08T16:24:08+01:00",
      "updated_at": "2026-10-08T16:24:08+01:00",
      "third_party": "nucleus",
      "reference": "AB123456"
    }
  },
  "created_at": "2026-10-08T16:24:03+01:00",
  "updated_at": "2026-10-08T16:24:03+01:00",
  "expires_at": "2026-11-07T16:24:03+00:00"
}