Vendor & Cookie Consent

Search Alt+S

Communicate with the Vendor & Cookie Consent app.

GET /apps/vcc/load_container/<container_id>

Returns a JSON object of all the authenticated user’s relationships from the vendors in this container.

Note: This endpoint does not require API authentication, but will check the user’s cookies for auth.

Authentication: This endpoint does not require traditional API authentication (such as an API key). Instead, it verifies the user’s identity by checking for valid authentication cookies.

Example Request

curl -X GET "https://api.privacybee.com/apps/vcc/load_container/<container_id>" -H "Accept: application/json"

Return: A JSON array of objects, with the following fields:

FieldData TypeDescription
is_authenticatedbooleanWhether the current user is authenticated with Privacy Bee or not
company.slugstringThe slug or token of the publisher who owns this container.
company.namestringThe human-readable name of the publisher
company.domainstringThe publisher’s primary domain
company.logostringThe URL to the publisher’s logo file
vendors[]arrayAn array of all the vendors within this container, appended with the trust settings of the currently authenticated user.
-- slugstringThe slug of the vendor
-- namestringThe human-readable name of the vendor
-- logostringThe URL to the vendor’s logo file
-- categorystringThe vendor’s publisher category
-- profile_urlstringThe URL of the vendor’s public trust profile
-- trustenum[trusted, negative]What is the current user’s relationship with this vendor?
Can be null if no trust relationship has been configured.

Note: If container_id from the request was missing, invalid, or disabled, an error will be returned.

{
    "is_authenticated": true,
    "company": {
        "slug": "publisher-slug",
        "name": "Publisher Name",
        "domain": "publisherdomain.com",
        "logo": "https://example.com/logos/publisher.png"
    },
    "vendors": [
        {
            "slug": "vendor-slug",
            "name": "Vendor Name",
            "logo": "https://example.com/logos/vendor.png",
            "category": "Vendor Category",
            "profile_url": "https://example.com/vendor-profile",
            "trust": "trusted" 
        },
        {
            "slug": "another-vendor-slug",
            "name": "Another Vendor Name",
            "logo": "https://example.com/logos/another-vendor.png",
            "category": "Another Vendor Category",
            "profile_url": "https://example.com/another-vendor-profile",
            "trust": "negative"
        }
    ]
}