CLclose
activities.sms

List or filter all SMS activities

Changed on

Get a list of matching SMS activities.

MMS messages are considered SMS messages with attachments. Attachments have identical fields to email attachments (url, filename, size and content_type), a media_id uniquely identifying an attachment, and if Close was able to generate a thumbnail, a thumbnail_url too.

Accessing url or thumbnail_url requires an authenticated session and leads to a temporarily signed S3 URL.

get/activity/sms/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/activity/sms/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Query parameters

_limitinteger

Number of results to return.

_skipinteger

Number of results to skip before returning, for pagination. The maximum is 35,000 for some organizations.

id__instring[] nullable

Filter by activity IDs (comma-separated)

lead_idstring[] nullable

Filter by lead IDs (comma-separated)

contact_idstring[] nullable

Filter by contact IDs (comma-separated)

user_idstring[] nullable

Filter by user IDs (comma-separated)

organization_idstring nullable
_typestring[] nullable

Filter by activity type, e.g. Call (comma-separated)

string date-time
OR
string date
string date-time
OR
string date
string date-time
OR
string date
string date-time
OR
string date
string date-time
OR
string date
string date-time
OR
string date
string date-time
OR
string date
string date-time
OR
string date
_fieldsstring

Comma-separated list of fields to include in the response.

Response

Successful response

has_moreboolean required

Changes

  • 7bdb9cfcca22Revision changes
    • warning

      for the query request parameter _limit, the max was set to 100.00

    • warning

      for the query request parameter _skip, the max was set to 250000.00

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status