---
updatedAt: 2026-04-21T22:43:00.000Z
agentTools:
  projectIndex: https://docs.scope3.com/llms.txt
---

# Get All Organization Segment Information

Returns filtered list of organization segments

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Management API",
    "description": "API to manage organization settings and data reports",
    "version": "2.0.0"
  },
  "servers": [
    {
      "url": "https://api.scope3.com/api/v2/"
    }
  ],
  "paths": {
    "/segment/list": {
      "get": {
        "operationId": "getOrganizationSegmentList",
        "summary": "Get All Organization Segment Information",
        "description": "Returns filtered list of organization segments",
        "parameters": [
          {
            "in": "query",
            "name": "page",
            "description": "Which page number being requested",
            "schema": {
              "type": "number",
              "minimum": 1
            }
          },
          {
            "in": "query",
            "name": "segmentId",
            "description": "specify the client segment id to fuzzy search filter on",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "includeDeactivated",
            "description": "whether to filter out deactivated segments",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "success response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SegmentList"
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/ErrorResponse"
          }
        }
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "DistributionMethod": {
        "type": "string",
        "enum": [
          "BUCKET_PUSH",
          "API_PULL",
          "INTEGRATION"
        ],
        "description": "The segment distribution method"
      },
      "UpdateFrequency": {
        "type": "string",
        "enum": [
          "DAILY",
          "MONTHLY"
        ],
        "description": "The segment update frequency"
      },
      "Paging": {
        "type": "object",
        "required": [
          "totalRecords"
        ],
        "properties": {
          "next": {
            "type": "string",
            "description": "The url to query for the next page of data"
          },
          "previous": {
            "type": "string",
            "description": "The url to query for the next page of data"
          },
          "totalRecords": {
            "type": "integer",
            "description": "The total number of records"
          }
        }
      },
      "SegmentList": {
        "type": "object",
        "required": [
          "segments",
          "paging"
        ],
        "properties": {
          "segments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Segment"
            }
          },
          "paging": {
            "$ref": "#/components/schemas/Paging"
          }
        }
      },
      "Segment": {
        "type": "object",
        "required": [
          "id",
          "name",
          "segmentId",
          "distributionMethod",
          "updateFrequency",
          "propertyLists",
          "placementLists",
          "createdAt"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "The internal Scope3 segment id"
          },
          "name": {
            "type": "string",
            "description": "The segment name"
          },
          "segmentId": {
            "type": "string",
            "description": "The client segment id"
          },
          "partners": {
            "type": "array",
            "nullable": true,
            "items": {
              "$ref": "#/components/schemas/SegmentPartner"
            },
            "description": "The client partners segment information"
          },
          "distributionMethod": {
            "$ref": "#/components/schemas/DistributionMethod"
          },
          "updateFrequency": {
            "$ref": "#/components/schemas/UpdateFrequency"
          },
          "channels": {
            "type": "array",
            "nullable": true,
            "items": {
              "type": "string"
            },
            "description": "Channels enabled in the segment - if not populated, all channels are enabled"
          },
          "propertyLists": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PropertyList"
            },
            "description": "The property lists included in the segment"
          },
          "placementLists": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PlacementList"
            },
            "description": "The placement lists included in the segment"
          },
          "fileName": {
            "type": "string",
            "description": "The filename template with macros for bucket pushed segment files"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Creation date and time",
            "example": "2021-01-30T08:30:00Z"
          },
          "deactivatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Deactivated date and time",
            "example": "2021-01-30T08:30:00Z"
          }
        }
      },
      "SegmentPartner": {
        "type": "object",
        "required": [
          "name",
          "segmentId"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The client partner's name"
          },
          "segmentId": {
            "type": "string",
            "description": "The client partner's segment id"
          },
          "seatId": {
            "nullable": true,
            "type": "string",
            "description": "The client partner's seat id"
          }
        }
      },
      "PropertyList": {
        "type": "object",
        "required": [
          "name",
          "countries",
          "isInclusion"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The property list name"
          },
          "countries": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The countries included in the segment"
          },
          "isInclusion": {
            "type": "boolean",
            "description": "Whether the property list is included or excluded from the segment"
          }
        }
      },
      "PlacementList": {
        "type": "object",
        "required": [
          "name",
          "countries"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The placement list name"
          },
          "countries": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The countries included in the segment"
          }
        }
      },
      "Err": {
        "type": "object",
        "required": [
          "message"
        ],
        "properties": {
          "message": {
            "type": "string"
          }
        }
      }
    },
    "responses": {
      "ErrorResponse": {
        "description": "unexpected error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Err"
            }
          }
        }
      }
    }
  }
}
```