List Audiences

GET

/v1/organizations/:organizationId/user-audiences/

Required Permission: mad.userAudience.organization.list

List Audiences

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^[a-fA-F0-9]{24}$

page integer

optional

Sequential page index for navigating large datasets, enabling systematic access to specific record subsets within the total collection.

limit integer

optional

Maximum number of records returned per request to control data density, optimize interface performance, and manage payload size.

sort string

optional

Ordering criteria using a field-to-direction mapping to organize results based on specific attributes like creation date, name, or status.

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

organizationId string

optional

Match pattern: ^[a-fA-F0-9]{24}$

applicationId string

optional

Match pattern: ^[a-fA-F0-9]{24}$

search string

optional

name string

optional

description string

optional

usersScope string

optional

orgapp

scope string

optional

orgapp

Responses

200 Response application/json

status boolean required

data object required

items array [object] required

id string required

Match pattern: ^[a-fA-F0-9]{24}$

name string required

description string optional

organizationId string required

Match pattern: ^[a-fA-F0-9]{24}$

applicationId string optional

Match pattern: ^[a-fA-F0-9]{24}$

application object optional

id string required

Match pattern: ^[a-fA-F0-9]{24}$

name string required

slug string required

picture string required

filter object required

groups array [array] required

emails array [string] required

usersScope string required

org app

allowedApplicationIds array [string] required

allowedApplications array [object] required

id string required

Match pattern: ^[a-fA-F0-9]{24}$

name string required

slug string required

picture string required

counts object required

pubApps number optional

members number optional

unmatchedEmails number optional

createdAt string required

updatedAt string 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": [
            {
                "id": "string",
                "name": "string",
                "description": "string",
                "organizationId": "string",
                "applicationId": "string",
                "application": {
                    "id": "string",
                    "name": "string",
                    "slug": "string",
                    "picture": "string"
                },
                "filter": {
                    "groups": [
                        [
                            "string"
                        ]
                    ],
                    "emails": [
                        "[email protected]"
                    ]
                },
                "usersScope": "org",
                "allowedApplicationIds": [
                    "string"
                ],
                "allowedApplications": [
                    {
                        "id": "string",
                        "name": "string",
                        "slug": "string",
                        "picture": "string"
                    }
                ],
                "counts": {
                    "pubApps": 0,
                    "members": 0,
                    "unmatchedEmails": 0
                },
                "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"
    }
}