List groups

List message groups (conversations) for a single company or person. Provide exactly one of companyId or personId.

GET/groups

Authorization

AuthorizationBearer token · headerrequired

Organization API key (modem_…).

Query parameters

companyIdstring

matches ^\d+$

personIdstring

matches ^\d+$

pageinteger

default: 1

limitinteger

max 50 · default: 20

Responses

200

dataobject[]required

Show properties

Array of object

groupobjectrequired

Show properties

archivedAtstring<date-time> | null

Timestamp when the group was archived.

Show properties

Any of:

string<date-time>

string<date-time>

null

null

endTimestampany

Timestamp for the end of the group time range.

idstring<uuid>required

Show properties

Any of:

string<uuid>

string<uuid>

string<uuid>

string<uuid>

startTimestampany

Timestamp for the start of the group time range.

messagesobject[]required

Show properties

Array of object

contentstringrequired

Full text content of the message.

createdAtstring<date-time>

Timestamp when the message was created.

deletedAtstring<date-time> | null

Timestamp when the message was deleted, if applicable.

Show properties

Any of:

string<date-time>

string<date-time>

null

null

editedAtstring<date-time> | null

Timestamp when the message was last edited.

Show properties

Any of:

string<date-time>

string<date-time>

null

null

idstring<uuid>required

Show properties

Any of:

string<uuid>

string<uuid>

string<uuid>

string<uuid>

isInternalbooleanrequired

Whether the message is an internal, team-only note withheld from the external/customer party (e.g. an internal agent note).

metadataobject | nullrequired

Additional metadata captured for the message.

Show properties

Any of:

object

object

null

null

replyToIdstring<uuid> | nullrequired

Internal message ID that this message replies to.

Show properties

Any of:

string<uuid>

string<uuid>

null

null

sourceMessageIdstringrequired

Identifier of the message in the source system.

sourceMessageTypestringrequired

Type/classification of the source message.

sourceNamestringrequired

Source system the message was ingested from.

matches ^[a-z0-9]+(?:-[a-z0-9]+)*$

sourceReplyToIdstring | nullrequired

Source system ID of the message being replied to.

Show properties

Any of:

string

string

null

null

sourceThreadIdstring | nullrequired

Thread identifier in the source system.

Show properties

Any of:

string

string

null

null

sourceUrlstring<uri> | nullrequired

URL linking to the original message when available.

Show properties

Any of:

string<uri>

string<uri>

null

null

threadIdstring<uuid> | nullrequired

Internal thread identifier when applicable.

Show properties

Any of:

string<uuid>

string<uuid>

null

null

titlestring | nullrequired

Optional title of the message.

Show properties

Any of:

string

string

null

null

authorobject | nullrequired

Show properties

Any of:

object

displayNamestring | nullrequired

Optional display name for the author.

Show properties

Any of:

string

string

null

null

idstring<uuid>required

Show properties

Any of:

string<uuid>

string<uuid>

string<uuid>

string<uuid>

isBotbooleanrequired

Whether the author is a bot account.

sourceAuthorIdstringrequired

Author identifier in the source system.

sourceAvatarUrlstring<uri> | nullrequired

Avatar image URL from the source system.

Show properties

Any of:

string<uri>

string<uri>

null

null

sourceNamestringrequired

Source system where the author originates.

matches ^[a-z0-9]+(?:-[a-z0-9]+)*$

null

null

channelobject | nullrequired

Show properties

Any of:

object

channelNamestringrequired

idstringrequired

serverNamestringrequired

null

null

reactionsobject[]required

Show properties

Array of object

countintegerrequired

Number of times this reaction was used.

identifierstringrequired

Normalized reaction identifier (e.g., "thumbsup", "heart").

messageIdstring<uuid>required

ID of the message this reaction belongs to.

Show properties

Any of:

string<uuid>

string<uuid>

string<uuid>

string<uuid>

unicodestring | nullrequired

Unicode representation of the emoji if applicable.

Show properties

Any of:

string

string

null

null

replyToobject | nullrequired

Show properties

Any of:

object

contentstringrequired

Full text content of the message.

createdAtstring<date-time>

Timestamp when the message was created.

deletedAtstring<date-time> | null

Timestamp when the message was deleted, if applicable.

Show properties

Any of:

string<date-time>

string<date-time>

null

null

editedAtstring<date-time> | null

Timestamp when the message was last edited.

Show properties

Any of:

string<date-time>

string<date-time>

null

null

idstring<uuid>required

Show properties

Any of:

string<uuid>

string<uuid>

string<uuid>

string<uuid>

isInternalbooleanrequired

Whether the message is an internal, team-only note withheld from the external/customer party (e.g. an internal agent note).

metadataobject | nullrequired

Additional metadata captured for the message.

Show properties

Any of:

object

object

null

null

replyToIdstring<uuid> | nullrequired

Internal message ID that this message replies to.

Show properties

Any of:

string<uuid>

string<uuid>

null

null

sourceMessageIdstringrequired

Identifier of the message in the source system.

sourceMessageTypestringrequired

Type/classification of the source message.

sourceNamestringrequired

Source system the message was ingested from.

matches ^[a-z0-9]+(?:-[a-z0-9]+)*$

sourceReplyToIdstring | nullrequired

Source system ID of the message being replied to.

Show properties

Any of:

string

string

null

null

sourceThreadIdstring | nullrequired

Thread identifier in the source system.

Show properties

Any of:

string

string

null

null

sourceUrlstring<uri> | nullrequired

URL linking to the original message when available.

Show properties

Any of:

string<uri>

string<uri>

null

null

threadIdstring<uuid> | nullrequired

Internal thread identifier when applicable.

Show properties

Any of:

string<uuid>

string<uuid>

null

null

titlestring | nullrequired

Optional title of the message.

Show properties

Any of:

string

string

null

null

authorobject | nullrequired

Show properties

Any of:

object

displayNamestring | nullrequired

Optional display name for the author.

Show properties

Any of:

string

string

null

null

idstring<uuid>required

Show properties

Any of:

string<uuid>

string<uuid>

string<uuid>

string<uuid>

isBotbooleanrequired

Whether the author is a bot account.

sourceAuthorIdstringrequired

Author identifier in the source system.

sourceAvatarUrlstring<uri> | nullrequired

Avatar image URL from the source system.

Show properties

Any of:

string<uri>

string<uri>

null

null

sourceNamestringrequired

Source system where the author originates.

matches ^[a-z0-9]+(?:-[a-z0-9]+)*$

null

null

null

null

threadobject | nullrequired

Show properties

Any of:

object

contentstringrequired

Full text content of the message.

createdAtstring<date-time>

Timestamp when the message was created.

deletedAtstring<date-time> | null

Timestamp when the message was deleted, if applicable.

Show properties

Any of:

string<date-time>

string<date-time>

null

null

editedAtstring<date-time> | null

Timestamp when the message was last edited.

Show properties

Any of:

string<date-time>

string<date-time>

null

null

idstring<uuid>required

Show properties

Any of:

string<uuid>

string<uuid>

string<uuid>

string<uuid>

isInternalbooleanrequired

Whether the message is an internal, team-only note withheld from the external/customer party (e.g. an internal agent note).

metadataobject | nullrequired

Additional metadata captured for the message.

Show properties

Any of:

object

object

null

null

replyToIdstring<uuid> | nullrequired

Internal message ID that this message replies to.

Show properties

Any of:

string<uuid>

string<uuid>

null

null

sourceMessageIdstringrequired

Identifier of the message in the source system.

sourceMessageTypestringrequired

Type/classification of the source message.

sourceNamestringrequired

Source system the message was ingested from.

matches ^[a-z0-9]+(?:-[a-z0-9]+)*$

sourceReplyToIdstring | nullrequired

Source system ID of the message being replied to.

Show properties

Any of:

string

string

null

null

sourceThreadIdstring | nullrequired

Thread identifier in the source system.

Show properties

Any of:

string

string

null

null

sourceUrlstring<uri> | nullrequired

URL linking to the original message when available.

Show properties

Any of:

string<uri>

string<uri>

null

null

threadIdstring<uuid> | nullrequired

Internal thread identifier when applicable.

Show properties

Any of:

string<uuid>

string<uuid>

null

null

titlestring | nullrequired

Optional title of the message.

Show properties

Any of:

string

string

null

null

authorobject | nullrequired

Show properties

Any of:

object

displayNamestring | nullrequired

Optional display name for the author.

Show properties

Any of:

string

string

null

null

idstring<uuid>required

Show properties

Any of:

string<uuid>

string<uuid>

string<uuid>

string<uuid>

isBotbooleanrequired

Whether the author is a bot account.

sourceAuthorIdstringrequired

Author identifier in the source system.

sourceAvatarUrlstring<uri> | nullrequired

Avatar image URL from the source system.

Show properties

Any of:

string<uri>

string<uri>

null

null

sourceNamestringrequired

Source system where the author originates.

matches ^[a-z0-9]+(?:-[a-z0-9]+)*$

null

null

null

null

topicobject | nullrequired

Show properties

Any of:

object

isV2booleanrequired

keywordsstring[]required

linkedIssueKeystring | nullrequired

Show properties

Any of:

string

string

null

null

sourcesstring[]required

topicIdstring<uuid>required

Show properties

Any of:

string<uuid>

string<uuid>

string<uuid>

string<uuid>

topicTitlestringrequired

topicTypestring | nullrequired

Show properties

Any of:

string

string

null

null

null

null

limitintegerrequired

The page size used for this response.

pageintegerrequired

The 1-based page number returned.

totalCountintegerrequired

Total number of items matching the query, across all pages.

min 0

400

Invalid request (validation failed).

codestringrequired

Machine-readable error code, e.g. NOT_FOUND.

dataany

Optional structured error details.

definedbooleanrequired

True if the error was declared in the procedure contract.

messagestringrequired

Human-readable error message.

statusintegerrequired

HTTP status code.

401

Missing or invalid API key.

codestringrequired

Machine-readable error code, e.g. NOT_FOUND.

dataany

Optional structured error details.

definedbooleanrequired

True if the error was declared in the procedure contract.

messagestringrequired

Human-readable error message.

statusintegerrequired

HTTP status code.

403

The API key does not have access to this resource.

codestringrequired

Machine-readable error code, e.g. NOT_FOUND.

dataany

Optional structured error details.

definedbooleanrequired

True if the error was declared in the procedure contract.

messagestringrequired

Human-readable error message.

statusintegerrequired

HTTP status code.

404

The requested resource was not found.

codestringrequired

Machine-readable error code, e.g. NOT_FOUND.

dataany

Optional structured error details.

definedbooleanrequired

True if the error was declared in the procedure contract.

messagestringrequired

Human-readable error message.

statusintegerrequired

HTTP status code.

429

Rate limit exceeded.

codestringrequired

Machine-readable error code, e.g. NOT_FOUND.

dataany

Optional structured error details.

definedbooleanrequired

True if the error was declared in the procedure contract.

messagestringrequired

Human-readable error message.

statusintegerrequired

HTTP status code.

500

Internal server error.

codestringrequired

Machine-readable error code, e.g. NOT_FOUND.

dataany

Optional structured error details.

definedbooleanrequired

True if the error was declared in the procedure contract.

messagestringrequired

Human-readable error message.

statusintegerrequired

HTTP status code.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

companyIdquerypersonIdquerypagequerylimitquery

Request

curl -X GET 'https://api.modem.dev/v1/groups' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.modem.dev/v1/groups", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.modem.dev/v1/groups",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "data": [
    {
      "group": {
        "archivedAt": "2019-08-24T14:15:22Z",
        "endTimestamp": null,
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "startTimestamp": null
      },
      "messages": [
        {
          "content": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "deletedAt": "2019-08-24T14:15:22Z",
          "editedAt": "2019-08-24T14:15:22Z",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "isInternal": true,
          "metadata": {
            "property1": null,
            "property2": null
          },
          "replyToId": "019c0f01-e197-45eb-8a17-c9811c373be9",
          "sourceMessageId": "string",
          "sourceMessageType": "string",
          "sourceName": "string",
          "sourceReplyToId": "string",
          "sourceThreadId": "string",
          "sourceUrl": "http://example.com",
          "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
          "title": "string",
          "author": {
            "displayName": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "isBot": true,
            "sourceAuthorId": "string",
            "sourceAvatarUrl": "http://example.com",
            "sourceName": "string"
          },
          "channel": {
            "channelName": "string",
            "id": "string",
            "serverName": "string"
          },
          "reactions": [
            {
              "count": 1,
              "identifier": "string",
              "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85",
              "unicode": "string"
            }
          ],
          "replyTo": {
            "content": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "deletedAt": "2019-08-24T14:15:22Z",
            "editedAt": "2019-08-24T14:15:22Z",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "isInternal": true,
            "metadata": {
              "property1": null,
              "property2": null
            },
            "replyToId": "019c0f01-e197-45eb-8a17-c9811c373be9",
            "sourceMessageId": "string",
            "sourceMessageType": "string",
            "sourceName": "string",
            "sourceReplyToId": "string",
            "sourceThreadId": "string",
            "sourceUrl": "http://example.com",
            "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
            "title": "string",
            "author": {
              "displayName": "string",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "isBot": true,
              "sourceAuthorId": "string",
              "sourceAvatarUrl": "http://example.com",
              "sourceName": "string"
            }
          },
          "thread": {
            "content": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "deletedAt": "2019-08-24T14:15:22Z",
            "editedAt": "2019-08-24T14:15:22Z",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "isInternal": true,
            "metadata": {
              "property1": null,
              "property2": null
            },
            "replyToId": "019c0f01-e197-45eb-8a17-c9811c373be9",
            "sourceMessageId": "string",
            "sourceMessageType": "string",
            "sourceName": "string",
            "sourceReplyToId": "string",
            "sourceThreadId": "string",
            "sourceUrl": "http://example.com",
            "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
            "title": "string",
            "author": {
              "displayName": "string",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "isBot": true,
              "sourceAuthorId": "string",
              "sourceAvatarUrl": "http://example.com",
              "sourceName": "string"
            }
          }
        }
      ],
      "topic": {
        "isV2": true,
        "keywords": [
          "string"
        ],
        "linkedIssueKey": "string",
        "sources": [
          "string"
        ],
        "topicId": "97b608a9-302e-4387-a5f4-fd35969cdc21",
        "topicTitle": "string",
        "topicType": "string"
      }
    }
  ],
  "limit": 1,
  "page": 1,
  "totalCount": 0
}

{
  "code": "NOT_FOUND",
  "data": null,
  "defined": true,
  "message": "string",
  "status": 404
}

{
  "code": "NOT_FOUND",
  "data": null,
  "defined": true,
  "message": "string",
  "status": 404
}

{
  "code": "NOT_FOUND",
  "data": null,
  "defined": true,
  "message": "string",
  "status": 404
}

{
  "code": "NOT_FOUND",
  "data": null,
  "defined": true,
  "message": "string",
  "status": 404
}

{
  "code": "NOT_FOUND",
  "data": null,
  "defined": true,
  "message": "string",
  "status": 404
}

{
  "code": "NOT_FOUND",
  "data": null,
  "defined": true,
  "message": "string",
  "status": 404
}