Sign in
message

Changed on
get/api/v1/message/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (scopes: write:message)
    • API key in cookie sessionid
    • none

Query parameters

format'csv' | 'json'
is_draftboolean
is_responseboolean
kind'email' | 'fax' | 'import' | 'phone' | 'post' | 'upload' | 'visit'
  • email - email
  • post - postal mail
  • fax - fax
  • upload - upload
  • phone - phone call
  • visit - visit in person
  • import - automatically imported
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

requestinteger

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

  • 2ba1a8b828b8Revision changes
    • breaking

      the response property // became optional for the status (media type: application/json)

    • breaking

      the response property // became optional for the status (media type: text/csv)

    • breaking

      the response property // became optional for the status (media type: application/json)

    • breaking

      the response property // became optional for the status (media type: text/csv)

    • breaking

      the response property // became optional for the status (media type: application/json)

    • breaking

      the response property // became optional for the status (media type: text/csv)

    • breaking

      the // response's property type changed from no type to string for status (media type: application/json)

    • warning

      added the new email enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new email enum value to the // response property for the response status (media type: text/csv)

    • warning

      added the new fax enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new fax enum value to the // response property for the response status (media type: text/csv)

    • warning

      added the new import enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new import enum value to the // response property for the response status (media type: text/csv)

    • warning

      added the new phone enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new phone enum value to the // response property for the response status (media type: text/csv)

    • warning

      added the new post enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new post enum value to the // response property for the response status (media type: text/csv)

    • warning

      added the new upload enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new upload enum value to the // response property for the response status (media type: text/csv)

    • warning

      added the new visit enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new visit enum value to the // response property for the response status (media type: text/csv)

    • info

      added the new optional query request parameter is_draft

    • info

      removed from the // response property allOf list for the response status (media type: application/json)

    • info

      removed from the // response property allOf list for the response status (media type: text/csv)

    • info

      the response's property default value true was added for the status (media type: application/json)

    • info

      the response's property default value true was added for the status (media type: text/csv)

    • info

      the response required property // became not read-only for the status (media type: application/json)

    • info

      the response required property // became not read-only for the status (media type: text/csv)

    • info

      the response required property // became not read-only for the status (media type: application/json)

    • info

      the response required property // became not read-only for the status (media type: text/csv)

    • info

      the response required property // became not read-only for the status (media type: application/json)

    • info

      the response required property // became not read-only for the status (media type: text/csv)

    • info

      the response required property // became not read-only for the status (media type: application/json)

    • info

      the response required property // became not read-only for the status (media type: text/csv)

  • f66b5d75cfd8Revision changes
    • breaking

      added to the // response property oneOf list for the response status (media type: application/json)

    • breaking

      added to the // response property oneOf list for the response status (media type: text/csv)

    • info

      the endpoint scheme security oauth2 was added to the API

    • info

      added to the // response property allOf list for the response status (media type: application/json)

    • info

      added to the // response property allOf list for the response status (media type: text/csv)

    • info

      removed from the // response property allOf list for the response status (media type: application/json)

    • info

      removed from the // response property allOf list for the response status (media type: text/csv)

    • info

      removed from the // response property oneOf list for the response status (media type: application/json)

    • info

      removed from the // response property oneOf list for the response status (media type: text/csv)