Get all circle conversations | PlannrCRM API documentation

Get all circle conversations Run in API Explorer

GET /api/v1/circles/{circle_uuid}/conversations

Personal access token & O auth2

Get all conversations where the circle accounts are participants.

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

circle_uuid string Required

Query parameters

include string

Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, latest_message, messages_count, files_count, case, tags].
filter[uuid] string

Filter by a comma separated list of UUIDs.
filter[archived] string

Return with or only archived conversations for current user. Valid options are [with, only, false]. Default is set to false.
sort string

Field to sort by. Valid fields are [created_at, latest_message, pinned_conversations]. Negative sign to denote DESC. Defaults to 'latest_message'.
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]
  
  Hide data attributes Show data attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  belongs_to_case boolean
  
  case object
  
  Hide case attributes Show case attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  status string
  
  type string
  
  review_at string
  
  assigned_to_uuids array[string]
  
  group_uuids array[string]
  
  completed_at string
  
  value object
  
  Hide value attributes Show value attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  status_position integer
  
  participants_count integer
  
  participants string
  
  task_board_uuid string
  
  plans string
  
  custom_fields string
  
  participants_count integer
  
  participants array[object]
  
  Hide participants attributes Show participants 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
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
  
  latest_message object
  
  Hide latest_message attributes Show latest_message attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  deleted_at string
  
  contents string
  
  edited boolean
  
  files string
  
  author string
  
  user string
  
  reactions string
  
  messages_count integer
  
  files_count integer
  
  tags array[object]
  
  Hide tags attributes Show tags attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  colour string
  
  pinned boolean
  
  is_admin boolean

GET /api/v1/circles/{circle_uuid}/conversations

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

Response examples (200)

{
  "data": [
    {
      "case": {
        "name": "finance",
        "slug": "finance",
        "type": "App\\Http\\Resources\\CasesTypeResource",
        "uuid": "0eb66eca-9e60-488a-b41d-e84bf466688d",
        "plans": "App\\Http\\Resources\\Plans\\PlanResource",
        "value": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          }
        },
        "status": "App\\Http\\Resources\\CasesStatusResource",
        "review_at": "2025-11-17T21:14:38+00:00",
        "created_at": "2025-11-17T21:14:38+00:00",
        "updated_at": "2025-11-17T21:14:38+00:00",
        "group_uuids": [
          "ea9cb742-4d2a-4545-87a9-a112c1e29530"
        ],
        "completed_at": "2025-11-17T21:14:38+00:00",
        "participants": "App\\Http\\Resources\\AccountResource",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "status_position": 4,
        "task_board_uuid": "75854cb8-8acd-4e28-a07a-3e0ca0cf126d",
        "assigned_to_uuids": [
          "a2a674a5-bab4-4950-8aa1-59c1d91cadad"
        ],
        "participants_count": 4
      },
      "name": "Welcome to Plannr",
      "slug": "welcome-to-plannr",
      "tags": [
        {
          "name": "Mortgage",
          "slug": "mortgage",
          "uuid": "723c8d72-3e27-404c-a52a-7c3cafc0f597",
          "colour": "#ef4582",
          "created_at": "2025-11-17T21:14:38+00:00",
          "updated_at": "2025-11-17T21:14:38+00:00"
        }
      ],
      "uuid": "ce393dca-66cd-47e8-8070-2c39f1f964d7",
      "pinned": true,
      "is_admin": false,
      "created_at": "2025-11-17T21:14:38+00:00",
      "updated_at": "2025-11-17T21:14:38+00:00",
      "files_count": 2,
      "participants": [
        {
          "firm": "App\\Http\\Resources\\FirmResource",
          "name": "Gareth Thompson",
          "role": "client",
          "tags": "App\\Http\\Resources\\TagResource",
          "type": "client",
          "uuid": "f81fb4de-9a05-4149-94e3-58f2a0df9d71",
          "email": "gareth@codepotato.co.uk",
          "groups": "App\\Http\\Resources\\GroupResource",
          "owners": "App\\Http\\Resources\\AccountResource",
          "circles": "App\\Http\\Resources\\CircleResource",
          "last_name": "Thompson",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "created_at": "2025-11-17T21:14:38+00:00",
          "first_name": "Gareth",
          "updated_at": "2025-11-17T21:14:38+00:00",
          "with_login": true,
          "inactive_at": "2025-11-17",
          "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
          "introduced_by": "App\\Http\\Resources\\AccountResource",
          "primary_email": "App\\Http\\Resources\\ContactDetailResource",
          "can_be_deleted": "false",
          "assigned_adviser": "App\\Http\\Resources\\AccountResource",
          "next_review_date": "2025-11-17T21:14:38+00:00",
          "has_joint_account": true,
          "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
          "first_contact_date": "2025-11-17T21:14:38+00:00",
          "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
          "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
          "joint_account_circle": "App\\Http\\Resources\\CircleResource",
          "ownership_percentage": 100,
          "previous_review_date": "2025-11-17T21:14:38+00:00",
          "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
          "assigned_administrator": "App\\Http\\Resources\\AccountResource",
          "anniversary_review_date": "2025-11-17T21:14:38+00:00"
        }
      ],
      "latest_message": {
        "user": "App\\Http\\Resources\\UserResource",
        "uuid": "7c7eb5ce-975e-475f-a317-ce6d2181c5ba",
        "files": "App\\Http\\Resources\\FileResource",
        "author": "App\\Http\\Resources\\AccountResource",
        "edited": true,
        "contents": "Welcome to Plannr!",
        "reactions": "App\\Http\\Resources\\ReactionResource",
        "created_at": "2025-11-17T21:14:38+00:00",
        "deleted_at": "2025-11-17T21:14:38+00:00",
        "updated_at": "2025-11-17T21:14:38+00:00"
      },
      "messages_count": 30,
      "belongs_to_case": true,
      "participants_count": 3
    }
  ]
}