UNunipile
Messaging

List all messages

Changed on

Returns a list of messages. Some optional parameters are available to filter the results.

get/api/v1/messages

Request

Query parameters

cursorstring

A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.

beforestring

A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).

Example:2025-12-31T23:59:59.999Z
afterstring

A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).

Example:2025-12-31T23:59:59.999Z
limitinteger

A limit for the number of items returned in the response. The value can be set between 1 and 250.

Example:100
sender_idstring

A filter to target messages received from a certain sender. The id of the sender targeted.

account_idstring

A filter to target messages received in a certain linked account. The id of the account targeted.

Response

OK. Request succeeded.

object'MessageList' required

Changes

  • e74f29ca2aaaRevision changes
    • warning

      added the new errors/password_reset_required enum value to the response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added subschema #15 to the // response property anyOf list for the response status

    • info

      added subschema #7 subschema #8 subschema #9 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #7 subschema #8 subschema #9 subschema #10 to the //// response property anyOf list for the response status