Docs
API ReferenceapicommsGET /v1/threads

GET /v1/threads

Service: comms · operationId: (none)

Lookup a 1:1 thread by participant ID (relative to the authenticated user).

Required scopes

(no scope declared — review service config)

Query parameters

  • participant_id (string) required —

Responses

200 Thread details

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "brand_id": {
      "type": "string"
    },
    "channel_cid": {
      "type": "string"
    },
    "participant_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "created_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "brand_id",
    "channel_cid",
    "participant_ids",
    "created_at"
  ]
}

404 Thread not found

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

503 Thread service not available

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X GET https://comms.platform.loop.health/v1/threads \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Related

GET /v1/suppressions/{email}GET /v1/threads/{id}