STstreakyc
Boxes

List organization boxes

Changed on

Returns accessible boxes linked to an organization. Pass the returned cursor to continue. hasNextPage indicates whether a continuation cursor is available, even if permission filtering leaves the results empty.

get/v2/organizations/{organizationKey}/boxes

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v2/organizations/{organizationKey}/boxes
  • Auth
    HTTP bearer

Path parameters

organizationKeystring required

Query parameters

cursorstring

Cursor returned by the previous response. Omit or leave empty to start from the beginning.

Response

OK

hasNextPageboolean

Whether another page is available. A page can be empty after permission filtering even when this is true.

cursorstring nullable

Continuation cursor for endpoints that use cursor pagination. Pass it as cursor to request the next page. Omitted for page-number pagination and when no continuation cursor remains.

Example response

{
  "results": [
    {
      "lastSavedTimestamp": 1646870400000,
      "creationTimestamp": 1646870400000,
      "lastUpdatedTimestamp": 1646870400000,
      "lastEmailUpdatedTimestamp": 1646870400000,
      "lastStageChangeTimestamp": 1646870400000,
      "lastCommentTimestamp": 1646870400000,
      "firstEmailTimestamp": 1646870400000,
      "firstEmailSentTimestamp": 1646870400000,
      "firstEmailReceivedTimestamp": 1646870400000,
      "lastEmailSentTimestamp": 1646870400000,
      "lastEmailReceivedTimestamp": 1646870400000,
      "contacts": [
        {
          "autoboxingTimestamp": 1646870400000
        }
      ],
      "organizations": [
        {
          "autoboxingTimestamp": 1646870400000
        }
      ],
      "soonestTaskDueDate": 1646870400000,
      "earliestOverdueTaskDueDate": 1646870400000,
      "mostRecentCallLogTimestamp": 1646870400000,
      "mostRecentMeetingNotesTimestamp": 1646870400000,
      "firstEventTimestamp": 1646870400000,
      "lastEventTimestamp": 1646870400000,
      "nextEventTimestamp": 1646870400000,
      "mostRecentLastSentEmailViewsTimestamp": 1646870400000,
      "mostRecentLastSentEmailLinkClickedTimestamp": 1646870400000,
      "mostRecentSentEmailsViewsTimestamp": 1646870400000,
      "firstCallLogTimestamp": 1646870400000,
      "firstMeetingNotesTimestamp": 1646870400000,
      "lastTouchpointTimestamp": 1646870400000,
      "stageHistoryEntries": [
        {
          "lastEntryToStageTs": 1646870400000
        }
      ]
    }
  ]
}

Changes

  • ece69aa69a9dRevision changes
    • info

      added the optional property // to the response with the 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 the optional property // to the response with the status

  • 1c3a5ef8b9eaRevision changes
    • info

      endpoint added