GET
/
v1
/
accounts
/
{accountId}
/
messages
cURL
curl -X GET \
  https://api.sakari.io/v1/accounts/{{ACCOUNT_ID}}/messages \
  -H 'Authorization: Bearer {{TOKEN}}'
{
  "success": true,
  "pagination": {
    "totalCount": 123,
    "limit": 123,
    "offset": 123,
    "hasNext": true
  },
  "data": [
    {
      "id": "<string>",
      "contact": {
        "id": "<string>",
        "email": "chris@sakari.io",
        "firstName": "Chris",
        "lastName": "Bloggs",
        "mobile": {
          "country": "<string>",
          "number": "123-456-7890",
          "verified": "2023-11-07T05:31:56Z",
          "valid": true,
          "lineType": "mobile"
        },
        "lists": [
          {
            "id": "<string>",
            "name": "<string>",
            "source": {
              "id": "<string>",
              "integration": "<string>",
              "lastSynced": "<string>"
            },
            "keyword": "<string>",
            "doubleOptIn": {
              "enabled": true,
              "prompt": "<string>"
            },
            "filter": {
              "q": "<string>",
              "attributes": [
                {
                  "attribute": "<string>",
                  "comparator": "<string>",
                  "value": [
                    "<string>"
                  ]
                }
              ],
              "list": "<string>",
              "valid": true,
              "invalid": true,
              "blocked": true,
              "unblocked": true,
              "optIn": true
            },
            "optInConfirmation": "<string>",
            "optIn": "2023-11-07T05:31:56Z",
            "optOut": "2023-11-07T05:31:56Z"
          }
        ],
        "attributes": {},
        "optIn": "2023-11-07T05:31:56Z",
        "blocked": "2023-11-07T05:31:56Z",
        "activecampaign": {
          "id": 123
        },
        "hubspot": {
          "id": 123
        },
        "pipedrive": {
          "id": 123
        },
        "valid": true,
        "error": {
          "code": "CONT-010",
          "description": "Contact has requested no further communication"
        },
        "created": {
          "at": "2023-11-07T05:31:56Z",
          "by": {
            "id": "<string>",
            "name": "Joe Bloggs",
            "firstName": "Joe",
            "lastName": "Bloggs",
            "email": "joe@bloggs.com",
            "source": "<string>",
            "subSource": "<string>"
          }
        },
        "updated": {
          "at": "2023-11-07T05:31:56Z",
          "by": {
            "id": "<string>",
            "name": "Joe Bloggs",
            "firstName": "Joe",
            "lastName": "Bloggs",
            "email": "joe@bloggs.com",
            "source": "<string>",
            "subSource": "<string>"
          }
        }
      },
      "conversation": {
        "id": "<string>",
        "contact": {
          "id": "<string>",
          "email": "chris@sakari.io",
          "firstName": "Chris",
          "lastName": "Bloggs",
          "mobile": {
            "country": "<string>",
            "number": "123-456-7890",
            "verified": "2023-11-07T05:31:56Z",
            "valid": true,
            "lineType": "mobile"
          },
          "lists": [
            {
              "id": "<string>",
              "name": "<string>",
              "source": {
                "id": "<string>",
                "integration": "<string>",
                "lastSynced": "<string>"
              },
              "keyword": "<string>",
              "doubleOptIn": {
                "enabled": true,
                "prompt": "<string>"
              },
              "filter": {
                "q": "<string>",
                "attributes": [
                  {
                    "attribute": "<string>",
                    "comparator": "<string>",
                    "value": [
                      "<string>"
                    ]
                  }
                ],
                "list": "<string>",
                "valid": true,
                "invalid": true,
                "blocked": true,
                "unblocked": true,
                "optIn": true
              },
              "optInConfirmation": "<string>",
              "optIn": "2023-11-07T05:31:56Z",
              "optOut": "2023-11-07T05:31:56Z"
            }
          ],
          "attributes": {},
          "optIn": "2023-11-07T05:31:56Z",
          "blocked": "2023-11-07T05:31:56Z",
          "activecampaign": {
            "id": 123
          },
          "hubspot": {
            "id": 123
          },
          "pipedrive": {
            "id": 123
          },
          "valid": true,
          "error": {
            "code": "CONT-010",
            "description": "Contact has requested no further communication"
          },
          "created": {
            "at": "2023-11-07T05:31:56Z",
            "by": {
              "id": "<string>",
              "name": "Joe Bloggs",
              "firstName": "Joe",
              "lastName": "Bloggs",
              "email": "joe@bloggs.com",
              "source": "<string>",
              "subSource": "<string>"
            }
          },
          "updated": {
            "at": "2023-11-07T05:31:56Z",
            "by": {
              "id": "<string>",
              "name": "Joe Bloggs",
              "firstName": "Joe",
              "lastName": "Bloggs",
              "email": "joe@bloggs.com",
              "source": "<string>",
              "subSource": "<string>"
            }
          }
        },
        "closed": "2023-11-07T05:31:56Z",
        "lastMessage": {},
        "phoneNumber": {
          "id": "<string>",
          "name": "<string>",
          "status": "<string>",
          "number": "<string>",
          "country": "<string>",
          "type": "<string>",
          "verified": true,
          "provider": "<string>",
          "supportedDestinations": [
            "<string>"
          ],
          "forwardTo": {},
          "universalReply": true,
          "channels": {
            "sms": {
              "active": true,
              "universalReply": true,
              "supportedDestinations": {},
              "regulatory": {
                "brandStatus": "<string>",
                "campaign": {
                  "id": "<string>",
                  "useCase": "<string>"
                },
                "pft": true,
                "submitted": "2023-11-07T05:31:56Z",
                "approved": "2023-11-07T05:31:56Z",
                "rejected": "2023-11-07T05:31:56Z"
              }
            },
            "voice": {
              "active": true,
              "incoming": {
                "action": "forward",
                "forwardTo": "<string>",
                "message": "<string>",
                "transcribe": true
              },
              "features": [
                "<string>"
              ]
            },
            "whatsapp": {
              "active": true
            }
          },
          "groups": [
            {
              "id": "<string>",
              "name": "<string>"
            }
          ],
          "hosted": true
        },
        "group": {
          "id": "<string>",
          "name": "<string>"
        },
        "unread": [
          "<string>"
        ],
        "created": {
          "at": "2023-11-07T05:31:56Z",
          "by": {
            "id": "<string>",
            "name": "Joe Bloggs",
            "firstName": "Joe",
            "lastName": "Bloggs",
            "email": "joe@bloggs.com",
            "source": "<string>",
            "subSource": "<string>"
          }
        },
        "updated": {
          "at": "2023-11-07T05:31:56Z",
          "by": {
            "id": "<string>",
            "name": "Joe Bloggs",
            "firstName": "Joe",
            "lastName": "Bloggs",
            "email": "joe@bloggs.com",
            "source": "<string>",
            "subSource": "<string>"
          }
        }
      },
      "group": {
        "id": "<string>",
        "name": "<string>",
        "phoneNumbers?": [
          {
            "id": "<string>",
            "name": "<string>",
            "status": "<string>",
            "number": "<string>",
            "country": "<string>",
            "type": "<string>",
            "verified": true,
            "provider": "<string>",
            "supportedDestinations": [
              "<string>"
            ],
            "forwardTo": {},
            "universalReply": true,
            "channels": {
              "sms": {
                "active": true,
                "universalReply": true,
                "supportedDestinations": {},
                "regulatory": {
                  "brandStatus": "<string>",
                  "campaign": {
                    "id": "<string>",
                    "useCase": "<string>"
                  },
                  "pft": true,
                  "submitted": "2023-11-07T05:31:56Z",
                  "approved": "2023-11-07T05:31:56Z",
                  "rejected": "2023-11-07T05:31:56Z"
                }
              },
              "voice": {
                "active": true,
                "incoming": {
                  "action": "forward",
                  "forwardTo": "<string>",
                  "message": "<string>",
                  "transcribe": true
                },
                "features": [
                  "<string>"
                ]
              },
              "whatsapp": {
                "active": true
              }
            },
            "groups": [
              {
                "id": "<string>",
                "name": "<string>"
              }
            ],
            "hosted": true
          }
        ],
        "notifications": [
          {
            "destination": {
              "id": "<string>",
              "name": "<string>"
            },
            "integration": "<string>",
            "group": {
              "id": "<string>",
              "name": "<string>"
            }
          }
        ],
        "tags": [
          "<string>"
        ],
        "users": [
          {
            "id": "<string>",
            "firstName": "<string>",
            "lastName": "<string>",
            "email": "<string>",
            "mobile": {
              "country": "<string>",
              "number": "123-456-7890",
              "verified": "2023-11-07T05:31:56Z",
              "valid": true,
              "lineType": "mobile"
            },
            "role": "Administrator"
          }
        ],
        "senders": [
          {
            "id": "<string>",
            "type": "phonenumber",
            "subType": "<string>",
            "status": "<string>",
            "identifier": "<string>",
            "channels": {
              "sms": {
                "active": true,
                "universalReply": true,
                "supportedDestinations": {},
                "regulatory": {
                  "brandStatus": "<string>",
                  "campaign": {
                    "id": "<string>",
                    "useCase": "<string>"
                  },
                  "pft": true,
                  "submitted": "2023-11-07T05:31:56Z",
                  "approved": "2023-11-07T05:31:56Z",
                  "rejected": "2023-11-07T05:31:56Z"
                }
              },
              "voice": {
                "active": true,
                "incoming": {
                  "action": "forward",
                  "forwardTo": "<string>",
                  "message": "<string>",
                  "transcribe": true
                },
                "features": [
                  "<string>"
                ]
              },
              "whatsapp": {
                "active": true
              }
            },
            "groups": [
              {
                "id": "<string>",
                "name": "<string>"
              }
            ],
            "created": {
              "at": "2023-11-07T05:31:56Z",
              "by": {
                "id": "<string>",
                "name": "Joe Bloggs",
                "firstName": "Joe",
                "lastName": "Bloggs",
                "email": "joe@bloggs.com",
                "source": "<string>",
                "subSource": "<string>"
              }
            },
            "updated": {
              "at": "2023-11-07T05:31:56Z",
              "by": {
                "id": "<string>",
                "name": "Joe Bloggs",
                "firstName": "Joe",
                "lastName": "Bloggs",
                "email": "joe@bloggs.com",
                "source": "<string>",
                "subSource": "<string>"
              }
            }
          }
        ],
        "officeHours": {
          "active": true,
          "timezone": "<string>",
          "times": {
            "sun": [
              {
                "start": {
                  "hour": 123,
                  "minute": 123
                },
                "end": {
                  "hour": 123,
                  "minute": 123
                }
              }
            ],
            "mon": [
              {
                "start": {
                  "hour": 123,
                  "minute": 123
                },
                "end": {
                  "hour": 123,
                  "minute": 123
                }
              }
            ],
            "tue": [
              {
                "start": {
                  "hour": 123,
                  "minute": 123
                },
                "end": {
                  "hour": 123,
                  "minute": 123
                }
              }
            ],
            "wed": [
              {
                "start": {
                  "hour": 123,
                  "minute": 123
                },
                "end": {
                  "hour": 123,
                  "minute": 123
                }
              }
            ],
            "thu": [
              {
                "start": {
                  "hour": 123,
                  "minute": 123
                },
                "end": {
                  "hour": 123,
                  "minute": 123
                }
              }
            ],
            "fri": [
              {
                "start": {
                  "hour": 123,
                  "minute": 123
                },
                "end": {
                  "hour": 123,
                  "minute": 123
                }
              }
            ],
            "sat": [
              {
                "start": {
                  "hour": 123,
                  "minute": 123
                },
                "end": {
                  "hour": 123,
                  "minute": 123
                }
              }
            ]
          }
        },
        "isDefault": true,
        "useSharedPool": true
      },
      "type": "<string>",
      "message": "<string>",
      "template": "<string>",
      "outgoing": true,
      "phoneNumber": "+1234567890",
      "price": 123,
      "segments": 123,
      "read": true,
      "status": "<string>",
      "media": [
        {
          "url": "<string>",
          "type": "<string>",
          "name": "<string>",
          "filename": "<string>"
        }
      ],
      "sendAt": "2023-11-07T05:31:56Z",
      "error": {
        "code": "CONT-010",
        "description": "Contact has requested no further communication"
      },
      "created": {
        "at": "2023-11-07T05:31:56Z",
        "by": {
          "id": "<string>",
          "name": "Joe Bloggs",
          "firstName": "Joe",
          "lastName": "Bloggs",
          "email": "joe@bloggs.com",
          "source": "<string>",
          "subSource": "<string>"
        }
      },
      "updated": {
        "at": "2023-11-07T05:31:56Z",
        "by": {
          "id": "<string>",
          "name": "Joe Bloggs",
          "firstName": "Joe",
          "lastName": "Bloggs",
          "email": "joe@bloggs.com",
          "source": "<string>",
          "subSource": "<string>"
        }
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

accountId
string
required

Account to apply operations to

Query Parameters

offset
integer

Results to skip when paginating through a result set

Required range: x >= 0
limit
integer

Maximum number of results to return

Required range: 1 <= x <= 100
contactId
string

ID of contact

conversationId
string

ID of conversation

Response

200
application/json

successful operation

The response is of type object.