/api/v1/chats/{id} (GET)

GET

/api/v1/chats/{id}

const url = 'https://api.endless.zaia.app/api/v1/chats/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.endless.zaia.app/api/v1/chats/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Retrieves a chat.

Parameters

Path Parameters

required

A UUID v4 string that identifies an entity.

string format: uuid

A UUID v4 string that identifies an entity.

Responses

200

Retrieves a chat.

application/json

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

updatedAt

required

string format: date-time

channelId

required

A UUID v4 string that identifies an entity.

string format: uuid

nullable

conversationVersion

required

integer

currentResponderId

required

A UUID v4 string that identifies an entity.

string format: uuid

nullable

lastActivityAt

required

string format: date-time

lastChatMessageCreatedAt

required

string format: date-time

nullable

ownerId

required

The super identity ID of the chat owner. Can refer to users.superIdentityId or externalUsers.superIdentityId.

string format: uuid

privateMemory

required

object

key

additional properties

Any of:

string

publicMemory

required

object

key

additional properties

Any of:

string

responderId

required

The super identity ID of the current chat responder. Can refer to agents.superIdentityId or squads.superIdentityId.

string format: uuid

title

required

string

nullable

workspaceId

required

A UUID v4 string that identifies an entity.

string format: uuid

tags

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

updatedAt

required

string format: date-time

activeTicketCount

required

The number of distinct pending or ongoing tickets linked to this tag via ticket_tags or chat_tags.

integer

color

required

The color of the tag.

string

Allowed values: default gray red orange yellow green blue purple pink brown

description

required

The description of the tag.

string

>= 3 characters <= 250 characters

name

required

The display name of the tag.

string

>= 3 characters <= 50 characters

workspaceId

required

The workspace that owns this tag.

string format: uuid

Example

{
  "tags": [
    {
      "color": "default"
    }
  ]
}

401

Unauthorized.

application/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}

404

Chat not found.

application/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}