Conversations

List Conversations

Lists the available conversations.

GET
/conversations.list

Authorization

AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Query Parameters

applies_to_parts?array<string>

Filters for conversations belonging to any of the provided parts.

brand?array<string>

Filters for tickets that are associated with any of the brands.

channels?array<string>

Filters for conversations that are associated with any of the channels.

cursor?string

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

Formattext
group?array<string>

Filters for conversation that belong to the given groups.

is_creator_verified?boolean

Filters for conversations that are created by verified users.

is_frozen?boolean

Filters for conversations that are frozen.

is_spam?boolean

Filters for conversations that are spam.

limit?integer

The maximum number of conversations to return. The default is '50'.

Formatint32
members?array<string>

Filters for conversations where these users are participants.

mode?string

The iteration mode to use, otherwise if not set, then "after" is used.

Value in"after" | "before"
modified_date.after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
modified_date.before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time
owned_by?array<string>

Filters for conversations owned by any of these users.

rev_org?array<string>Deprecated

Filters for conversations that are associated with any of the provided Rev organizations.

rev_orgs?array<string>

Filters for conversations that are associated with any of the provided Rev organizations.

sla_summary.stage?array<sla-summary-stage>

Filters for records with any of the provided SLA stages.

source_channel?array<string>

Filters for conversations with any of the provided source channels.

source_channel_v2?array<string>

Filters for conversations that are associated with the source channel.

source_channels?array<string>Deprecated

Filters for conversations with any of the provided source channels.

stage.name?array<string>

Filters for records in the provided stage(s) by name.

state?array<string>

Filters for conversations with any of the provided states.

tags?array<string>Deprecated

Filters for conversations with any of the provided tags.

tags_v2.id?string

The ID of the tag.

Formatid
tags_v2.value?string

The value for the object's association with the tag. If specified, the value must be one that's specified in the tag's allowed values.

Formattext

Response Body

curl -X GET "https://api.devrev.ai/conversations.list?applies_to_parts=PROD-12345&brand=string&channels=string&cursor=string&group=string&is_creator_verified=true&is_frozen=true&is_spam=true&limit=0&members=DEVU-12345&mode=after&modified_date.after=2023-01-01T12%3A00%3A00.000Z&modified_date.before=2023-01-01T12%3A00%3A00.000Z&owned_by=DEVU-12345&rev_org=REV-AbCdEfGh&rev_orgs=REV-AbCdEfGh&sla_summary.stage=breached&source_channel=string&source_channel_v2=string&source_channels=string&stage.name=string&state=string&tags=TAG-12345&tags_v2.id=TAG-12345&tags_v2.value=string"
{
  "conversations": [
    {
      "created_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "created_date": "2023-01-01T12:00:00.000Z",
      "display_id": "string",
      "id": "string",
      "modified_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "modified_date": "2023-01-01T12:00:00.000Z",
      "channels": [
        {
          "display_id": "string",
          "id": "string"
        }
      ],
      "description": "string",
      "group": {
        "display_id": "string",
        "id": "string"
      },
      "members": [
        {
          "type": "dev_user",
          "display_id": "string",
          "id": "string",
          "display_name": "string",
          "display_picture": {
            "display_id": "string",
            "id": "string",
            "file": {
              "type": "string",
              "name": "string",
              "size": 0
            }
          },
          "email": "string",
          "full_name": "string",
          "state": "active"
        }
      ],
      "messages": [
        {
          "type": "timeline_comment",
          "created_by": {
            "type": "dev_user",
            "display_id": "string",
            "id": "string",
            "display_name": "string",
            "display_picture": {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            },
            "email": "string",
            "full_name": "string",
            "state": "active"
          },
          "created_date": "2023-01-01T12:00:00.000Z",
          "display_id": "string",
          "id": "string",
          "modified_by": {
            "type": "dev_user",
            "display_id": "string",
            "id": "string",
            "display_name": "string",
            "display_picture": {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            },
            "email": "string",
            "full_name": "string",
            "state": "active"
          },
          "modified_date": "2023-01-01T12:00:00.000Z",
          "object": "string",
          "object_display_id": "string",
          "object_type": "article",
          "visibility": "external",
          "artifacts": [
            {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            }
          ],
          "body": "string",
          "body_type": "data",
          "references": [
            {
              "type": "article",
              "display_id": "string",
              "id": "string",
              "article_type": "article",
              "resource": {
                "artifacts": [
                  {
                    "display_id": "string",
                    "id": "string",
                    "file": {
                      "type": "string",
                      "name": "string",
                      "size": 0
                    }
                  }
                ],
                "url": "string"
              },
              "title": "string"
            }
          ],
          "snap_kit_body": {
            "body": {},
            "snap_in_action_name": "string",
            "snap_in_id": "string"
          },
          "snap_widget_body": [
            {
              "type": "string"
            }
          ]
        }
      ],
      "metadata": {
        "url_context": "string"
      },
      "owned_by": [
        {
          "type": "dev_user",
          "display_id": "string",
          "id": "string",
          "display_name": "string",
          "display_picture": {
            "display_id": "string",
            "id": "string",
            "file": {
              "type": "string",
              "name": "string",
              "size": 0
            }
          },
          "email": "string",
          "full_name": "string",
          "state": "active"
        }
      ],
      "sla_summary": {
        "closest_to_breach_metric": "string",
        "org_schedule": {
          "display_id": "string",
          "id": "string",
          "name": "string",
          "status": "archived",
          "timezone": "string",
          "valid_until": "2023-01-01T12:00:00.000Z"
        },
        "remaining_time": 0,
        "sla_tracker": {
          "created_by": {
            "type": "dev_user",
            "display_id": "string",
            "id": "string",
            "display_name": "string",
            "display_picture": {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            },
            "email": "string",
            "full_name": "string",
            "state": "active"
          },
          "created_date": "2023-01-01T12:00:00.000Z",
          "display_id": "string",
          "id": "string",
          "modified_by": {
            "type": "dev_user",
            "display_id": "string",
            "id": "string",
            "display_name": "string",
            "display_picture": {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            },
            "email": "string",
            "full_name": "string",
            "state": "active"
          },
          "modified_date": "2023-01-01T12:00:00.000Z",
          "applies_to_id": "string",
          "applies_to_type": "conversation",
          "metric_target_summaries": [
            {
              "breached_at": "2023-01-01T12:00:00.000Z",
              "completed_at": "2023-01-01T12:00:00.000Z",
              "completed_in": 0,
              "in_policy": true,
              "is_out_of_schedule": true,
              "metric_definition": {
                "display_id": "string",
                "id": "string",
                "name": "string"
              },
              "next_schedule_transition": "2023-01-01T12:00:00.000Z",
              "org_schedule": {
                "display_id": "string",
                "id": "string",
                "name": "string",
                "status": "archived",
                "timezone": "string",
                "valid_until": "2023-01-01T12:00:00.000Z"
              },
              "remaining_time": 0,
              "stage": "string",
              "status": "string",
              "target_time": "2023-01-01T12:00:00.000Z",
              "warning_target_time": "2023-01-01T12:00:00.000Z"
            }
          ],
          "removed_sla_metric_history": [
            {}
          ],
          "sla": {
            "display_id": "string",
            "id": "string",
            "name": "string",
            "sla_type": "external",
            "status": "archived"
          },
          "sla_policy_id": "string",
          "stage": "string",
          "status": "string"
        },
        "stage": "breached",
        "target_time": "2023-01-01T12:00:00.000Z"
      },
      "sla_tracker": {
        "display_id": "string",
        "id": "string",
        "applies_to_type": "conversation"
      },
      "source_channel": "string",
      "source_channel_v2": {
        "display_id": "string",
        "id": "string"
      },
      "stage": {
        "name": "string"
      },
      "tags": [
        {
          "tag": {
            "display_id": "string",
            "id": "string",
            "name": "string"
          },
          "value": "string"
        }
      ],
      "title": "string"
    }
  ],
  "next_cursor": "string",
  "prev_cursor": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}

List Conversations (POST) POST

Previous Page

Update Conversation POST

Next Page