API Reference

Get grouped audience navigation

Returns the flat folder navigation with explicit folder and audience positions. Audiences still being populated by an active prospecting job are excluded, so every returned audience is ready for audience operations. Use the returned IDs before any organization or membership write; names are not identifiers.

GET/v1/accounts/{accountGroupId}/audiences/navigation

Integration notes

Required API permission

audiences:read.

Prerequisites

integration_api_key, account_group_access.

Parameters

accountGroupIdPath

Type: string

Account group ID that scopes the request.

Required

Request body

This endpoint does not define a request body.

Responses

200

Grouped audience navigation

Schema: AudienceNavigationSuccessResponse

400

Request validation failed

Schema: ValidationErrorResponse

401

Invalid or missing API key

Schema: ErrorResponse

403

Missing required permission

Schema: ErrorResponse

429

Rate limit exceeded

Schema: ErrorResponse

500

Internal server error

Schema: ErrorResponse

Response examples

200 Example JSONAudienceNavigationSuccessResponse

{
    "success": true,
    "data": {
        "folders": [
            {
                "id": "507f1f77bcf86cd799439011",
                "name": "Avery Stone",
                "audienceType": "on_demand",
                "isPinned": true,
                "position": 25,
                "createdAt": "string",
                "updatedAt": "string",
                "audiences": [
                    {
                        "id": "507f1f77bcf86cd799439011",
                        "name": "Avery Stone",
                        "type": "string",
                        "description": "string",
                        "folderId": "507f1f77bcf86cd799439011",
                        "position": "string",
                        "prospectCount": "string",
                        "createdAt": "string",
                        "updatedAt": "string"
                    }
                ]
            }
        ],
        "ungroupedAudiences": [
            {
                "id": "507f1f77bcf86cd799439011",
                "name": "Avery Stone",
                "type": "linkedin_search",
                "description": "string",
                "folderId": "507f1f77bcf86cd799439011",
                "position": 25,
                "prospectCount": 25,
                "createdAt": "string",
                "updatedAt": "string"
            }
        ]
    },
    "error": null,
    "traceId": "507f1f77bcf86cd799439011"
}

400 Example JSONValidationErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

401 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

403 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

429 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}

500 Example JSONErrorResponse

{
    "success": false,
    "data": null,
    "error": {
        "code": "string",
        "message": "Thanks for the context. I can send over details this afternoon.",
        "details": "string"
    },
    "traceId": "507f1f77bcf86cd799439011"
}