Get a conversation.

GET /api/v1/conversation/{uuid}
Personal access token & OAuth2

Path parameters

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • name string

      Conversation title

    • slug string

      Conversation title as a slug

    • belongs_to_case boolean

      Whether or not the conversation belongs to a case.

    • case object

      Case the conversation belongs to (if included)

      Additional properties are allowed.

    • participants_count integer

      Number of participants in conversation (if included)

    • participants array[object]

      Participants in this conversation (if included)

      Additional properties are allowed.

    • latest_message object

      The latest message of the conversation (if included)

      Additional properties are allowed.

    • messages_count integer

      Number of messages in the conversation (if included)

    • files_count integer

      Number of files in the conversation (if included)

    • tags array[object]

      Conversation tags (if included)

      Additional properties are allowed.

    • pinned boolean

      Whether the conversation has been pinned to the top (if participants included)

    • is_admin boolean

      If the authenticated account is an admin of the conversation (if participants included)
GET /api/v1/conversation/{uuid} 
curl \
 --request GET https://api.plannrcrm.com/api/v1/conversation/uuid \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "case": {
    "name": "finance",
    "slug": "finance",
    "type": "App\\Http\\Resources\\CasesTypeResource",
    "uuid": "20ddfe7d-e328-4e86-8245-e7352bb0e60b",
    "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",
    "created_at": "2025-02-20T10:13:02+00:00",
    "updated_at": "2025-02-20T10:13:02+00:00",
    "completed_at": "2025-02-20T10:13:02+00:00",
    "participants": "App\\Http\\Resources\\AccountResource",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "status_position": 4,
    "task_board_uuid": "4d7aa0bd-80f8-4831-8c8e-87a834e26907",
    "participants_count": 4
  },
  "name": "Welcome to Plannr",
  "slug": "welcome-to-plannr",
  "tags": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "d8d36b01-651f-4c53-94c2-943c5c1548f1",
      "colour": "#ef4582",
      "created_at": "2025-02-20T10:13:02+00:00",
      "updated_at": "2025-02-20T10:13:02+00:00"
    }
  ],
  "uuid": "4b16e7e3-639b-4d86-902a-be8ac77ab8bc",
  "pinned": true,
  "is_admin": false,
  "created_at": "2025-02-20T10:13:02+00:00",
  "updated_at": "2025-02-20T10:13:02+00:00",
  "files_count": 2,
  "participants": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "7c3f189a-312a-4723-8abe-53f7170f2e59",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "last_name": "Thompson",
      "created_at": "2025-02-20T10:13:02+00:00",
      "first_name": "Gareth",
      "updated_at": "2025-02-20T10:13:02+00:00",
      "with_login": true,
      "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-02-20T10:13:02+00:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2025-02-20T10:13:02+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "previous_review_date": "2025-02-20T10:13:02+00:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2025-02-20T10:13:02+00:00"
    }
  ],
  "latest_message": {
    "user": "App\\Http\\Resources\\UserResource",
    "uuid": "9edaa607-7fe3-4769-b25a-871d7404eaca",
    "files": "App\\Http\\Resources\\FileResource",
    "author": "App\\Http\\Resources\\AccountResource",
    "edited": true,
    "contents": "Welcome to Plannr!",
    "reactions": "App\\Http\\Resources\\ReactionResource",
    "created_at": "2025-02-20T10:13:02+00:00",
    "deleted_at": "2025-02-20T10:13:02+00:00",
    "updated_at": "2025-02-20T10:13:02+00:00"
  },
  "messages_count": 30,
  "belongs_to_case": true,
  "participants_count": 3
}