Get User Audience

GET

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

Required Permission: mad.userAudience.organization.get

Get User Audience

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

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

Responses

200 Response application/json

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

{
    "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"
}

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"
    }
}