Inbox

List inbox messages

Retrieves a paginated list of inbox messages with optional filtering

get/inboxmessage.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/inboxmessage.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: read_inbox

Query parameters

limitinteger

Maximum number of messages to return (1-500)

offsetinteger

Number of messages to skip for pagination

filter'all' | 'unread' | 'archived' | 'snoozed'

Filter messages by status

searchstring

Search messages by subject, from name, or from email

Response

Successful response

Changes

No recorded changes to this operation across all 50 revisions of this API.