Back

    Buyamia Directory API

    v1.0

    Businesses

    The Businesses API provides read and write access to all business listings in the Directory. Each business represents a supplier or service provider with details including contact information, location, categories, verification status, and more.

    Read endpoints require businesses.read. Write endpoints require businesses.write.

    Available Endpoints

    GET
    /v1/businesses

    List businesses with pagination and filters

    businesses.read
    GET
    /v1/businesses/:id

    Get full business detail by UUID

    businesses.read
    GET
    /v1/businesses/slug/:slug

    Get business by URL slug

    businesses.read
    GET
    /v1/businesses/:id/products

    List products for a business

    businesses.read
    GET
    /v1/businesses/:id/performance

    Supplier performance metrics

    businesses.read
    GET
    /v1/businesses/:id/capabilities

    Supplier capabilities

    businesses.read
    GET
    /v1/businesses/:id/assets

    Business documents and files

    businesses.read
    POST
    /v1/businesses

    Create a new business listing

    businesses.write
    PUT
    /v1/businesses/:id

    Update an existing business

    businesses.write
    POST
    /v1/businesses/:id/performance

    Submit supplier performance feedback

    businesses.write

    Business Data Model

    FieldTypeDescription
    iduuidUnique identifier
    namestringBusiness name
    slugstringURL-friendly identifier
    descriptionstringBusiness description
    addressstringPhysical address
    phonestringPhone number
    emailstringEmail address
    websitestringWebsite URL
    whatsapp_numberstringWhatsApp number
    verifiedbooleanVerification status
    featuredbooleanFeatured listing
    category_iduuidPrimary category
    region_iduuidRegion location
    country_iduuidCountry
    imagesstring[]Image URLs
    year_establishedintegerYear business was founded
    employee_count_rangestringEmployee count range (e.g., "50-100")
    certificationsstring[]Business certifications
    data_quality_scoreintegerData completeness score (0-100)
    Last updated on February 23, 2026