GET /:country/categories

Returns a list of Categories to identify the branch (category) of the customer’s business. The list can optionally be filtered by name.

Note that the full list of categories can be quite large, so it might be a good idea to cache it locally instead of fetching it too frequently.

URL Parameters

name Optional

If set, filters the list by category name. Supports * wildcards, for example: computer* or *psycho*.

Response

On success returns a 200 OK reply with the folowing data:

numFound	The number of categories found.
categories	An array of Categories (can be empty).

On error returns an Error object.

Example

GET https://api.opendi.com/de/categories?name=%2Apsycho%2A

200 OK

{
    "numFound": 6,
    "categories": [
        {
            "id": "2072",
            "name": "Heilpraktiker: Psychotherapie"
        },
        {
            "id": "2825",
            "name": "Verkehrspsychologie"
        },
        {
            "id": "4085",
            "name": "Psychologieschulen"
        },
        {
            "id": "4260",
            "name": "Raumpsychologie"
        },
        {
            "id": "5081",
            "name": "Körperpsychotherapeut"
        },
        {
            "id": "5665",
            "name": "Ärzte: Psychotherapie"
        }
    ]
}