List segment permissions

GET

/v1/organizations/:organizationId/segment-permissions/

List segment permissions

Required Permission: base.organization.segmentPermission.list

List segment permissions

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

page integer

optional

Page number for pagination navigation through segment permission results.

limit integer

optional

Maximum number of segment permission records returned per page.

sort string

optional

Ordering criteria for segment permission results using field:direction format.

Match pattern: ^[\w.]*((:asc)|(:desc))?$

segmentId integer

optional

Segment identifier scoping this permission to a specific organizational segment for resource access control.

expandTo string

optional

Expansion directive controlling which related segment data is included in the permission response.

ancestorschildren

search string

optional

Free-text search filter applied to segment permission name and description fields.

≤ 256 characters

Responses

200 Response application/json

status boolean required

data object required

items array [array] required

totalDocs integer required

≥ -9007199254740991 · ≤ 9007199254740991

limit integer required

≥ -9007199254740991 · ≤ 9007199254740991

hasPrevPage boolean required

hasNextPage boolean required

page integer required

≥ -9007199254740991 · ≤ 9007199254740991

totalPages integer required

≥ -9007199254740991 · ≤ 9007199254740991

prevPage integer required

≥ -9007199254740991 · ≤ 9007199254740991

nextPage integer required

≥ -9007199254740991 · ≤ 9007199254740991

{
    "status": true,
    "data": {
        "items": [
            [
                {
                    "items": [
                        {
                            "id": "string",
                            "name": "string",
                            "description": "string",
                            "segmentId": 0,
                            "users": {
                                "emails": [
                                    "[email protected]"
                                ],
                                "groups": [
                                    [
                                        "string"
                                    ]
                                ]
                            },
                            "roles": [
                                "string"
                            ],
                            "counts": {
                                "members": 0,
                                "unmatchedEmails": 0
                            },
                            "actions": [
                                "string"
                            ],
                            "createdAt": "string",
                            "updatedAt": "string"
                        }
                    ]
                }
            ]
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}