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

# Get Organization Segment Data by Segment ID

Returns requested data for the segment

# 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/data": {
      "get": {
        "operationId": "getOrganizationSegmentDataBySegmentId",
        "summary": "Get Organization Segment Data by Segment ID",
        "description": "Returns requested data for the segment",
        "parameters": [
          {
            "in": "query",
            "name": "segmentId",
            "schema": {
              "type": "string"
            },
            "description": "client segment id"
          },
          {
            "in": "query",
            "name": "id",
            "schema": {
              "type": "string"
            },
            "description": "scope3 internal segment id"
          }
        ],
        "responses": {
          "200": {
            "description": "success response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SegmentDataResponse"
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/ErrorResponse"
          }
        }
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "SegmentDataType": {
        "type": "string",
        "enum": [
          "INCLUDED_PROPERTY",
          "EXCLUDED_PROPERTY",
          "EXCLUDED_PROPERTY_PLACEMENTS"
        ],
        "description": "The segment data type"
      },
      "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"
          }
        }
      },
      "SegmentDataResponse": {
        "type": "object",
        "required": [
          "data",
          "paging"
        ],
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SegmentData"
            },
            "description": "The segment data"
          },
          "paging": {
            "$ref": "#/components/schemas/Paging"
          }
        }
      },
      "SegmentData": {
        "type": "object",
        "required": [
          "id",
          "segmentId",
          "type",
          "property",
          "channel",
          "country",
          "inventoryId"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "The internal Scope3 segment id"
          },
          "segmentId": {
            "type": "string",
            "description": "The client segment id"
          },
          "type": {
            "$ref": "#/components/schemas/SegmentDataType"
          },
          "property": {
            "type": "string",
            "description": "The property that the inventory belongs to"
          },
          "channel": {
            "type": "string",
            "description": "The property channel"
          },
          "country": {
            "type": "string",
            "description": "The country, is not populated applies worldwide"
          },
          "inventoryId": {
            "type": "string",
            "description": "The inventory identifier"
          },
          "appStore": {
            "type": "string",
            "nullable": true,
            "description": "If the inventory is an app, populated with the the app store"
          },
          "gpids": {
            "type": "array",
            "nullable": true,
            "items": {
              "type": "string"
            },
            "description": "The GPIDs excluded for the given property"
          }
        }
      },
      "Err": {
        "type": "object",
        "required": [
          "message"
        ],
        "properties": {
          "message": {
            "type": "string"
          }
        }
      }
    },
    "responses": {
      "ErrorResponse": {
        "description": "unexpected error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Err"
            }
          }
        }
      }
    }
  }
}
```