---
updatedAt: 2026-09-01T20:42:06.000Z
---

# List segment sharing relationships

Returns a list of segment sharing relationships where segments are shared between accounts. Shows which segments are shared, the owner account, and the recipient account.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Reference Resources",
    "version": "2.0.0",
    "description": "Buzz API v2"
  },
  "paths": {
    "/shared/segments": {
      "get": {
        "operationId": "shared_segments_list",
        "description": "Returns a list of segment sharing relationships where segments are shared between accounts. Shows which segments are shared, the owner account, and the recipient account.",
        "summary": "List segment sharing relationships",
        "parameters": [
          {
            "in": "query",
            "name": "account_id",
            "schema": {
              "type": "number"
            }
          },
          {
            "in": "query",
            "name": "account_id__in",
            "schema": {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "description": "Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "in": "query",
            "name": "account_id__not",
            "schema": {
              "type": "number"
            }
          },
          {
            "in": "query",
            "name": "account_id__not_in",
            "schema": {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "description": "Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "in": "query",
            "name": "active",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "query",
            "name": "alternative_id",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "alternative_id__contains",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "alternative_id__in",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "in": "query",
            "name": "alternative_id__isempty",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "query",
            "name": "alternative_id__not",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "alternative_id__not_contains",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "alternative_id__not_in",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "in": "query",
            "name": "alternative_id__not_startswith",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "alternative_id__startswith",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cpm_cost",
            "schema": {
              "type": "number"
            },
            "description": "Only return sharing relationships whose CPM cost exactly matches this value."
          },
          {
            "in": "query",
            "name": "cpm_cost__gt",
            "schema": {
              "type": "number"
            },
            "description": "Only return sharing relationships whose CPM cost is greater than this value."
          },
          {
            "in": "query",
            "name": "cpm_cost__in",
            "schema": {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "description": "Only return sharing relationships whose CPM cost matches one of these values. Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "in": "query",
            "name": "cpm_cost__lt",
            "schema": {
              "type": "number"
            },
            "description": "Only return sharing relationships whose CPM cost is less than this value."
          },
          {
            "in": "query",
            "name": "cpm_cost__not",
            "schema": {
              "type": "number"
            },
            "description": "Exclude sharing relationships whose CPM cost exactly matches this value."
          },
          {
            "in": "query",
            "name": "cpm_cost__not_in",
            "schema": {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "description": "Exclude sharing relationships whose CPM cost matches one of these values. Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "in": "query",
            "name": "create_date",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "create_date__gt",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "create_date__gte",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "create_date__isempty",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "query",
            "name": "create_date__lt",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "create_date__lte",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "create_date__range",
            "schema": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$",
              "example": "2025-09-29 00:00:00",
              "enum": [
                "future",
                "last_14_complete_days",
                "last_14_days",
                "last_24_hours",
                "last_30_complete_days",
                "last_30_days",
                "last_365_complete_days",
                "last_365_days",
                "last_7_complete_days",
                "last_7_days",
                "last_90_complete_days",
                "last_90_days",
                "last_month",
                "last_quarter",
                "last_week",
                "last_year",
                "past",
                "this_month",
                "this_quarter",
                "this_week",
                "this_year",
                "today",
                "until_past_24_hours",
                "yesterday"
              ]
            },
            "description": "The date and time the object was first created\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"
          },
          {
            "in": "query",
            "name": "id",
            "schema": {
              "type": "number"
            }
          },
          {
            "in": "query",
            "name": "id__gt",
            "schema": {
              "type": "number"
            }
          },
          {
            "in": "query",
            "name": "id__gte",
            "schema": {
              "type": "number"
            }
          },
          {
            "in": "query",
            "name": "id__in",
            "schema": {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "description": "Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "in": "query",
            "name": "id__lt",
            "schema": {
              "type": "number"
            }
          },
          {
            "in": "query",
            "name": "id__lte",
            "schema": {
              "type": "number"
            }
          },
          {
            "in": "query",
            "name": "id__not",
            "schema": {
              "type": "number"
            }
          },
          {
            "in": "query",
            "name": "id__not_in",
            "schema": {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "description": "Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "in": "query",
            "name": "key",
            "schema": {
              "type": "string"
            },
            "description": "Only return sharing relationships whose shared segment key exactly matches this value."
          },
          {
            "in": "query",
            "name": "key__in",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Only return sharing relationships whose shared segment key matches one of these values. Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "in": "query",
            "name": "key__isempty",
            "schema": {
              "type": "boolean"
            },
            "description": "When true, only return sharing relationships with an empty or missing shared segment key. When false, exclude them."
          },
          {
            "in": "query",
            "name": "key__not",
            "schema": {
              "type": "string"
            },
            "description": "Exclude sharing relationships whose shared segment key exactly matches this value."
          },
          {
            "in": "query",
            "name": "key__not_in",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Exclude sharing relationships whose shared segment key matches one of these values. Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "in": "query",
            "name": "notes",
            "schema": {
              "type": "string"
            },
            "description": "Only return sharing relationships whose note text exactly matches this value."
          },
          {
            "in": "query",
            "name": "notes__in",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Only return sharing relationships whose note text matches one of these values. Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "in": "query",
            "name": "notes__isempty",
            "schema": {
              "type": "boolean"
            },
            "description": "When true, only return sharing relationships with an empty or missing note text. When false, exclude them."
          },
          {
            "in": "query",
            "name": "notes__not",
            "schema": {
              "type": "string"
            },
            "description": "Exclude sharing relationships whose note text exactly matches this value."
          },
          {
            "in": "query",
            "name": "notes__not_in",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Exclude sharing relationships whose note text matches one of these values. Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "name": "order",
            "required": false,
            "in": "query",
            "description": "Which field to use when ordering the results.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "shared_account_id",
            "schema": {
              "type": "number"
            },
            "description": "Only return sharing relationships whose shared account ID exactly matches this value."
          },
          {
            "in": "query",
            "name": "shared_account_id__in",
            "schema": {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "description": "Only return sharing relationships whose shared account ID matches one of these values. Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "in": "query",
            "name": "shared_account_id__not",
            "schema": {
              "type": "number"
            },
            "description": "Exclude sharing relationships whose shared account ID exactly matches this value."
          },
          {
            "in": "query",
            "name": "shared_account_id__not_in",
            "schema": {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "description": "Exclude sharing relationships whose shared account ID matches one of these values. Multiple values may be separated by commas.",
            "explode": false,
            "style": "form"
          },
          {
            "in": "query",
            "name": "update_date",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "update_date__gt",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "update_date__gte",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "update_date__isempty",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "query",
            "name": "update_date__lt",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "update_date__lte",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "update_date__range",
            "schema": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$",
              "example": "2025-09-29 00:00:00",
              "enum": [
                "future",
                "last_14_complete_days",
                "last_14_days",
                "last_24_hours",
                "last_30_complete_days",
                "last_30_days",
                "last_365_complete_days",
                "last_365_days",
                "last_7_complete_days",
                "last_7_days",
                "last_90_complete_days",
                "last_90_days",
                "last_month",
                "last_quarter",
                "last_week",
                "last_year",
                "past",
                "this_month",
                "this_quarter",
                "this_week",
                "this_year",
                "today",
                "until_past_24_hours",
                "yesterday"
              ]
            },
            "description": "The date and time the object was last updated\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"
          }
        ],
        "tags": [
          "Segments"
        ],
        "security": [
          {
            "nestSessionAuth": []
          },
          {
            "nestBasicAuth": []
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaginatedSegmentSharingList"
                }
              }
            },
            "description": "Segment sharing relationships retrieved successfully."
          },
          "400": {
            "description": "Invalid filter or query parameters."
          },
          "401": {
            "description": "Authentication credentials were not provided."
          },
          "403": {
            "description": "Permission denied."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "PaginatedSegmentSharingList": {
        "type": "object",
        "required": [
          "count",
          "results"
        ],
        "properties": {
          "count": {
            "type": "integer",
            "example": 123
          },
          "next": {
            "type": "string",
            "nullable": true,
            "format": "uri",
            "example": "http://api.example.org/accounts/?page=4"
          },
          "previous": {
            "type": "string",
            "nullable": true,
            "format": "uri",
            "example": "http://api.example.org/accounts/?page=2"
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SegmentSharing"
            }
          }
        }
      },
      "SegmentSharing": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "readOnly": true,
            "description": "The unique ID of the sharing relationship."
          },
          "account_id": {
            "type": "integer",
            "description": "Defaults to the account in the active session"
          },
          "shared_account_id": {
            "type": "integer",
            "description": "The account the segment is shared with."
          },
          "key": {
            "type": "string",
            "description": "Key of the segment being shared."
          },
          "cpm_cost": {
            "type": "string",
            "format": "decimal",
            "pattern": "^-?\\d{0,3}(?:\\.\\d{0,2})?$",
            "nullable": true,
            "description": "The CPM cost for the shared segment."
          },
          "active": {
            "type": "boolean",
            "default": true,
            "description": "Whether the sharing relationship is active."
          },
          "create_date": {
            "type": "string",
            "readOnly": true,
            "nullable": true,
            "description": "The date and time the object was first created",
            "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$",
            "example": "2025-09-29 00:00:00"
          },
          "update_date": {
            "type": "string",
            "readOnly": true,
            "nullable": true,
            "description": "The date and time the object was last updated",
            "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$",
            "example": "2025-09-29 00:00:00"
          },
          "alternative_id": {
            "type": "string",
            "nullable": true,
            "description": "An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.",
            "maxLength": 200
          },
          "notes": {
            "type": "string",
            "nullable": true,
            "description": "Free-form notes of up to 255 characters.",
            "maxLength": 255
          }
        },
        "required": [
          "account_id",
          "create_date",
          "id",
          "key",
          "shared_account_id",
          "update_date"
        ]
      }
    },
    "securitySchemes": {
      "nestBasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Form-based Basic Authentication"
      },
      "nestSessionAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Form-based Basic Authentication"
      }
    }
  },
  "x-explorer-enabled": false,
  "x-samples-languages": [
    "curl",
    "node",
    "ruby",
    "javascript",
    "python",
    "php",
    "java"
  ],
  "servers": [
    {
      "url": "https://{buzz_key}.api.beeswax.com/rest/v2",
      "variables": {
        "buzz_key": {
          "default": "stingersbx",
          "description": "Unique customer ID assigned by the Beeswax"
        }
      }
    }
  ],
  "x-readme": {
    "apply-endpoint-order": true,
    "apply-tag-changes": true
  }
}
```