Skip to content
digizeDocs

List conversations

GET
/api/v1/conversations
curl --request GET \
  --url https://digize.com/api/v1/conversations \
  --header 'x-api-key: <x-api-key>'

Texts, calls and emails with contacts, one conversation per contact and channel, the newest first. Returns up to 1,000 and how many there are.

Needs the crm:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
rows
required
Array<object>
object
id
required
string
contact
required
object
id
required
string
name
required
string
firstName
required
string
email
required
string | null
phone
required
string | null
channel
required
string
Allowed values: sms email
address
required

The workspace’s number or address the contact writes to.

string
subject
required

Emails only.

string | null
status
required
string
Allowed values: open closed
assigneeId
required

The member answering it, by user id.

string | null
unread
required
boolean
lastMessage
required
Any of:
object
kind
required
string
Allowed values: message call
direction
required
string
Allowed values: in out
authorKind
required
string
Allowed values: contact team automation system
body
required

The start of it, on one line.

string
status
required
string
Allowed values: pending queued sent delivered failed undelivered received
sentAt
required
string format: date-time
lastMessageAt
required
string format: date-time
optedOut
required

A text conversation whose contact replied STOP: nothing can be texted to them until they reply START.

boolean
createdAt
required
string format: date-time
total
required
number

Example 

{
  "rows": [
    {
      "channel": "sms",
      "status": "open",
      "lastMessage": {
        "kind": "message",
        "direction": "in",
        "authorKind": "contact",
        "status": "pending"
      }
    }
  ]
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}