Get Organization Conversations

Returns conversations associated with an organization with the given ID.

Request

GET /v2/organizations/10/conversations?page=1 HTTP/1.1
Authorization: Bearer oauth_token

Path Parameters

/v2/organizations/{organizationId}/conversations

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
  "_embedded" : {
    "conversations" : [ {
      "id" : 23,
      "number" : 12,
      "threads" : 2,
      "type" : "email",
      "folderId" : 85,
      "status" : "closed",
      "state" : "published",
      "subject" : "Help with organization setup",
      "preview" : "Need help setting up the organization...",
      "mailboxId" : 13,
      "assignee" : {
        "id" : 4,
        "type" : "user",
        "first" : "Support",
        "last" : "Agent",
        "email" : "agent@helpscout.com"
      },
      "createdBy" : {
        "id" : 100,
        "type" : "customer",
        "email" : "john@testcompany.com"
      },
      "createdAt" : "2023-06-15T10:30:00Z",
      "closedBy" : 4,
      "closedByUser" : {
        "id" : 4,
        "type" : "user",
        "first" : "Support",
        "last" : "Agent",
        "photoUrl" : "https://example.com/agent.jpg",
        "email" : "agent@helpscout.com"
      },
      "closedAt" : "2023-06-20T16:00:00Z",
      "userUpdatedAt" : "2023-06-20T14:45:00Z",
      "source" : {
        "type" : "email",
        "via" : "customer"
      },
      "tags" : [ {
        "id" : 9150,
        "color" : "#9239499",
        "tag" : "vip"
      } ],
      "cc" : [ ],
      "bcc" : [ ],
      "primaryCustomer" : {
        "id" : 100,
        "type" : "customer",
        "first" : "John",
        "last" : "Doe",
        "email" : "john@testcompany.com"
      },
      "customFields" : [ ],
      "_links" : {
        "self" : {
          "href" : "..."
        },
        "mailbox" : {
          "href" : "..."
        },
        "primaryCustomer" : {
          "href" : "..."
        },
        "createdByCustomer" : {
          "href" : "..."
        },
        "closedBy" : {
          "href" : "..."
        },
        "threads" : {
          "href" : "..."
        },
        "assignee" : {
          "href" : "..."
        },
        "web" : {
          "href" : "..."
        }
      }
    }, {
      "id" : 24,
      "number" : 13,
      "threads" : 1,
      "type" : "email",
      "folderId" : 85,
      "status" : "open",
      "state" : "published",
      "subject" : "Follow-up question",
      "preview" : "I have a follow-up question about...",
      "mailboxId" : 13,
      "assignee" : {
        "id" : 4,
        "type" : "user",
        "first" : "Support",
        "last" : "Agent",
        "email" : "agent@helpscout.com"
      },
      "createdBy" : {
        "id" : 101,
        "type" : "customer",
        "email" : "jane@testcompany.com"
      },
      "createdAt" : "2023-06-21T09:00:00Z",
      "userUpdatedAt" : "2023-06-21T09:15:00Z",
      "source" : {
        "type" : "email",
        "via" : "customer"
      },
      "tags" : [ ],
      "cc" : [ ],
      "bcc" : [ ],
      "primaryCustomer" : {
        "id" : 101,
        "type" : "customer",
        "first" : "Jane",
        "last" : "Smith",
        "email" : "jane@testcompany.com"
      },
      "customFields" : [ ],
      "_links" : {
        "self" : {
          "href" : "..."
        },
        "mailbox" : {
          "href" : "..."
        },
        "primaryCustomer" : {
          "href" : "..."
        },
        "createdByCustomer" : {
          "href" : "..."
        },
        "threads" : {
          "href" : "..."
        },
        "assignee" : {
          "href" : "..."
        },
        "web" : {
          "href" : "..."
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "..."
    },
    "first" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "page" : {
      "href" : "..."
    }
  },
  "page" : {
    "size" : 50,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 1
  }
}

Response fields

Path Type Description
_embedded.conversations Array Array of Conversation objects