SCscanopy
Shares

List shares

Changed on
get/api/v1/shares

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/shares
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Query parameters

site_idstring uuid nullable

Filter by site ID

topology_idstring uuid nullable

Filter by topology ID

limitinteger nullable

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

offsetinteger nullable

Number of results to skip. Default: 0.

Response

List of Shares

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.19.4"
  }
}

Changes

  • f3bf5869fbc9Revision changes
    • breaking

      removed the required property /////// from the response with the status

  • 3076f6ba82fdRevision changes
    • warning

      removed the optional property ////// from the response with the status

    • info

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