Skip to content

Clarification on the ability to use undocumented API endpoint #181

@adimmitt

Description

@adimmitt

When trying to get the list of categories to use in sending to Birdeye. We found in the documentation this API: https://developers.birdeye.com/#/reference/category/all-categories/get-all-categories which calls this route: https://api.birdeye.com/resources/v1/category/all.

This lists all categories like:

[
    "3D Printing",
    "Acai Bowls",
    "Accessories",
    "Accountants",
    "Acne Treatment",
    "Acupuncture",
    "Addiction Medicine",
    "Adoption Services",
    ....
]

but does not have the details of their hierarchy of them.

We found that the API route https://api.birdeye.com/resources/v1/category returns the desired details like:

[
    {
        "id": 1,
        "name": "Advertising / Media / Agency",
        "childCategories": [
            {
                "id": 30,
                "name": "Reputation Management",
                "childCategories": [],
                "coverImageUrl": "advertising-media.jpg",
                "schemaType": null
            },
            {
                "id": 1299,
                "name": "Advertising / Media / Agency",
                "childCategories": [],
                "coverImageUrl": "advertising-media.jpg",
                "schemaType": null
            },
            ...
]

Is this an acceptable route to use for development to get the list of appropriate categories and subcategories?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions