NogPets Services API

What we do, where, and for how much. Public.

GitHub OpenAPI

Operations 2

GET /v1/services Service lines, services and prices #
GET /v1/coverage Do you come to this address? #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nogpets-com:nogpets-com-services-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nogpets-com-services-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NogPets Services API
  version: 1.4.0
  summary: Run your pet grooming business from any AI assistant; register a pet business from anywhere; book grooming, walks and sitting in Stellenbosch.
  description: '**Run your pet business** (tag Run, scope `business:manage`): the owners, managers and

    staff of an approved NogPets business run it from their assistant. Today''s day plan per

    van or walker, bookings, clients and notes, prices, working hours, time off, service

    areas, earnings, payouts and who hasn''t paid; book a phone or walk-in client, rebook,

    move or cancel, send a client their Payfast link, and make an invoice link with a QR

    code for any amount. Staff read their own day; owners and managers make changes.

    Every change is logged with the assistant''s name, and anything that touches bookings,

    prices, areas or money answers `CONFIRM_REQUIRED` with a summary first. Booking through

    NogPets is for South African businesses (rand, Johannesburg time); elsewhere those tools

    answer `NOT_AVAILABLE_IN_COUNTRY` and the rest works in the business''s own currency and

    time zone.


    **For pet businesses, anywhere in the world** (tag Business, scope `business:write`):

    a groomer, dog walker or pet sitter registers and manages their business on NogPets

    through their own assistant, in their own country, currency and time zone. Every

    application is a draft until NogPets approves it.


    **For pet owners in Stellenbosch, South Africa**, where NogPets runs its own vans and

    walkers: check coverage, prices and open times without signing in; with the person''s

    permission, book, move, cancel and pay, and buy from the shop when it is open. A request

    we can''t serve (another town or country, or a fully booked week) is noted for a person

    at NogPets to follow up (`NO_COVERAGE` / `NO_AVAILABILITY` with `leadId` and `message`).


    - **The person approves money.** A card booking or order comes back with a `payUrl`

    the person opens to pay on Payfast. Nothing here takes a card. A cash booking needs

    `confirm: true`, sent only after the person has seen the summary and said yes.

    - **Same rules as the app.** Prices, coverage, open times and cancellation windows

    come from the same server code; the API adds none of its own.

    - Booking money is integer cents in South African rand (ZAR): `38000` is R380. Times

    are ISO 8601 instants; booking local time is Africa/Johannesburg (UTC+2). A business

    application''s prices are in the business''s own `currency` (minor units) and its hours

    in its own `timezone`.

    - Errors are `{"error": {"code", "message", "details"}}`; `code` is stable

    (e.g. `NO_COVERAGE`, `SLOT_TAKEN`, `CONFIRM_REQUIRED`).


    Reads marked public need no auth. Everything about a person needs an OAuth 2.1

    access token (authorization code + PKCE) or a personal API key, as a Bearer token.

    The same operations are MCP tools at `https://mcp.nogpets.com/mcp`.


    **Business sign-up, in order** (the first call says the `country`):

    startBusinessSignup → addBusinessServices → setServiceArea → addResources → setOperatingHours → inviteStaff

    (optional) → connectPayfast (optional, South Africa only, merchant id only) →

    getSignupStatus → submitBusinessForReview (`confirm: true` after the person saw the

    summary). Every answer carries `next` and a `statusUrl` page for the person.'
  contact:
    name: NogPets
    email: hello@nogpets.com
    url: https://nogpets.com/developers
  termsOfService: https://nogpets.com/terms
servers:
- url: https://api.nogpets.com
  description: Production
security: []
tags:
- name: Services
  description: What we do, where, and for how much. Public.
paths:
  /v1/services:
    get:
      operationId: listServices
      tags:
      - Services
      summary: Service lines, services and prices
      description: Every service line (grooming, walks, pet sitting), its services with prices by pet size and coat, the card fee, and the areas we cover.
      x-mcp-tool:
        name: list_services
        title: What NogPets offers
        annotations:
          readOnlyHint: true
          destructiveHint: false
          idempotentHint: true
          openWorldHint: false
        description: 'Lists NogPets'' services (mobile dog grooming at the door, dog walks, pet sitting) with prices and durations, the R10 card fee, whether cash is taken, and the Stellenbosch suburbs we cover.

          Use it first when the person asks what NogPets does, how much something costs, or which service to pick. Prices depend on the pet: `tiers` give the price by weight and coat (first match wins; minKg inclusive, maxKg exclusive). For an exact price for the person''s pets, call get_quote.

          Service `id`s are what get_quote, find_times and book take in `serviceIds`: exactly one PRIMARY service per pet plus any EXTRAs of the same line.

          '
      responses:
        '200':
          description: The catalogue
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Services'
              example:
                currency: ZAR
                serviceFeeCents: 1000
                acceptsCash: true
                areas:
                - Stellenbosch Central
                - Die Boord
                - Paradyskloof
                lines:
                - id: grooming
                  label: Grooming
                  blurb: Our van at your door. Bath, cut and nails.
                  durationMode: SUM
                  repeats: false
                  services:
                  - id: full-groom
                    name: Full groom
                    kind: PRIMARY
                    blurb: Bath, cut, blow-dry, nails and ears.
                    petTypes:
                    - DOG
                    priceCents: 38000
                    durationMin: 60
                    fromCents: 38000
                    toCents: 68000
                    groupSize: 1
                    tiers:
                    - coat: LONG
                      maxKg: 10
                      priceCents: 46000
                      durationMin: 75
                    - maxKg: 10
                      priceCents: 38000
                      durationMin: 60
        '429':
          $ref: '#/components/responses/RateLimited'
  /v1/coverage:
    get:
      operationId: checkCoverage
      tags:
      - Services
      summary: Do you come to this address?
      description: Places a typed address, a postal code or a map point in our territories and says which service lines reach it. When nothing does, `nearest` names our closest area.
      x-mcp-tool:
        name: check_coverage
        title: Check an address is covered
        annotations:
          readOnlyHint: true
          destructiveHint: false
          idempotentHint: true
          openWorldHint: false
        description: 'Checks whether NogPets'' own vans and walkers come to an address (today: Stellenbosch, South Africa), and for which services. Give `address` as the person typed it, anywhere in the world (a Stellenbosch address with its suburb or postal code, e.g. "12 Dorp Street, Stellenbosch Central 7600", or a full address with town and country), or `lat` and `lng`.

          Use it before quoting or booking for a new address. `covered: false` (`NO_COVERAGE`) means we don''t serve there yet: the request is noted (`leadId`) for a person at NogPets, who may follow up. Tell the person exactly `message`; follow `next`. Never promise a visit, a time or a price for an address that isn''t covered.

          '
      parameters:
      - name: address
        in: query
        description: An address as typed (with its suburb or postal code; abroad, with its town and country), or "lat,lng".
        schema:
          type: string
          maxLength: 300
        example: 14 Kromrivier Street, Die Boord, Stellenbosch 7613
      - name: lat
        in: query
        schema:
          type: number
          minimum: -90
          maximum: 90
      - name: lng
        in: query
        schema:
          type: number
          minimum: -180
          maximum: 180
      - name: postalCode
        in: query
        schema:
          type: string
          pattern: ^[A-Za-z0-9][A-Za-z0-9 -]{1,9}$
      responses:
        '200':
          description: The answer (covered or not)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Coverage'
              examples:
                covered:
                  value:
                    covered: true
                    place:
                      suburb: Die Boord
                      postalCode: '7613'
                      lat: -33.9467
                      lng: 18.848
                    lines:
                    - id: grooming
                      label: Grooming
                      covered: true
                    - id: walking
                      label: Walks
                      covered: true
                    - id: sitting
                      label: Pet sitting
                      covered: true
                    nearest: null
                notCovered:
                  value:
                    covered: false
                    error: NO_COVERAGE
                    place:
                      suburb: null
                      postalCode: '7646'
                      lat: -33.73
                      lng: 18.96
                    lines:
                    - id: grooming
                      label: Grooming
                      covered: false
                    nearest:
                      name: Welgevonden
                      distanceKm: 20.4
                abroad:
                  value:
                    covered: false
                    error: NO_COVERAGE
                    leadId: hot-0c3f9a1e2b4d5c6a7e8f9a0b
                    message: Thanks Sam. NogPets doesn't serve the United States yet. We've noted your request, and a person from NogPets may follow up.
                    next: NogPets doesn't serve the United States yet. Tell the person that, and that we've noted their request and a person from NogPets may follow up (use `message`). Don't offer times, prices or a booking there, and don't suggest another NogPets area.
                    place:
                      suburb: null
                      postalCode: '78701'
                      lat: 30.2711
                      lng: -97.7437
                      town: Austin
                      country: US
                    lines:
                    - id: grooming
                      label: Grooming
                      covered: false
                    nearest: null
        '400':
          $ref: '#/components/responses/BadRequest'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    PetType:
      type: string
      enum:
      - DOG
      - CAT
    LineCoverage:
      type: object
      required:
      - id
      - label
      - covered
      properties:
        id:
          type: string
        label:
          type: string
        covered:
          type: boolean
    Services:
      type: object
      required:
      - currency
      - serviceFeeCents
      - acceptsCash
      - areas
      - lines
      properties:
        currency:
          type: string
          const: ZAR
        serviceFeeCents:
          type: integer
          description: Added to card payments only.
        acceptsCash:
          type: boolean
        areas:
          type: array
          items:
            type: string
          description: Suburbs we cover.
        lines:
          type: array
          items:
            type: object
            required:
            - id
            - label
            - services
            properties:
              id:
                type: string
              label:
                type: string
              blurb:
                type: string
              durationMode:
                type: string
                enum:
                - SUM
                - MAX
                description: 'SUM: pets one after the other; MAX: together.'
              repeats:
                type: boolean
                description: Can repeat weekly.
              services:
                type: array
                items:
                  $ref: '#/components/schemas/Service'
              packages:
                type: array
                items:
                  $ref: '#/components/schemas/Package'
    Coat:
      type: string
      enum:
      - SHORT
      - MEDIUM
      - LONG
    Coverage:
      type: object
      required:
      - covered
      - lines
      properties:
        covered:
          type: boolean
        error:
          type: string
          enum:
          - NO_COVERAGE
          - UNKNOWN_PLACE
        leadId:
          type:
          - string
          - 'null'
          description: 'NO_COVERAGE: the request is kept so our team can follow up.'
        message:
          type: string
          description: 'NO_COVERAGE: what to tell the person.'
        next:
          type: string
          description: 'NO_COVERAGE: what to do (say it plainly; promise nothing).'
        place:
          oneOf:
          - $ref: '#/components/schemas/Place'
          - type: 'null'
        lines:
          type: array
          items:
            $ref: '#/components/schemas/LineCoverage'
        nearest:
          oneOf:
          - type: 'null'
          - type: object
            properties:
              name:
                type: string
              distanceKm:
                type: number
    Service:
      type: object
      required:
      - id
      - name
      - kind
      - priceCents
      - durationMin
      - fromCents
      - toCents
      properties:
        id:
          type: string
        name:
          type: string
        kind:
          type: string
          enum:
          - PRIMARY
          - EXTRA
        blurb:
          type: string
        petTypes:
          type: array
          items:
            $ref: '#/components/schemas/PetType'
        priceCents:
          type: integer
          description: Base price when no tier matches.
        durationMin:
          type: integer
        fromCents:
          type: integer
        toCents:
          type: integer
        groupSize:
          type: integer
          description: More than 1 is a group walk sharing the slot.
        tiers:
          type: array
          items:
            $ref: '#/components/schemas/Tier'
    Tier:
      type: object
      properties:
        petType:
          $ref: '#/components/schemas/PetType'
        coat:
          $ref: '#/components/schemas/Coat'
        minKg:
          type: number
        maxKg:
          type: number
        priceCents:
          type: integer
        durationMin:
          type: integer
    Place:
      type: object
      properties:
        suburb:
          type:
          - string
          - 'null'
        postalCode:
          type:
          - string
          - 'null'
        lat:
          type:
          - number
          - 'null'
        lng:
          type:
          - number
          - 'null'
        town:
          type:
          - string
          - 'null'
          description: 'Abroad: the town it was found in.'
        country:
          type: string
          description: 'Abroad only: ISO 3166 code of the place''s country.'
    Package:
      type: object
      required:
      - id
      - name
      - includes
      - fromCents
      - toCents
      description: A main service and extras in one choice, priced from its parts for the pet (their tiers), less bundleDiscountPct.
      properties:
        id:
          type: string
        name:
          type: string
        blurb:
          type: string
        includes:
          type: array
          items:
            type: string
          description: 'Service ids: one PRIMARY and EXTRAs.'
        bundleDiscountPct:
          type: number
        petTypes:
          type: array
          items:
            $ref: '#/components/schemas/PetType'
        fromCents:
          type: integer
        toCents:
          type: integer
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
              description: Stable, upper-case.
            message:
              type: string
              description: Short and human; safe to show.
            details:
              type: object
              additionalProperties: true
  responses:
    RateLimited:
      description: Too many requests (`RATE_LIMIT`). `Retry-After` says when to try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: The input is wrong (`INVALID_ARGUMENT`, or a pricing code such as `ONE_PRIMARY`, `PET_TYPE`, `UNKNOWN_SERVICE`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ONE_PRIMARY
              message: Pick one main service for Biscuit
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.1, authorization code with PKCE (S256), public clients. Register with `POST /oauth/register` (RFC 7591). Access tokens last an hour; refresh tokens rotate.
      flows:
        authorizationCode:
          authorizationUrl: https://api.nogpets.com/oauth/authorize
          tokenUrl: https://api.nogpets.com/oauth/token
          refreshUrl: https://api.nogpets.com/oauth/token
          scopes:
            profile: See your name, email and phone
            pets: See and add your pets
            addresses: See and add your addresses
            bookings:read: See your bookings
            bookings:write: Book, move, cancel and get payment links for your bookings
            orders:write: Place shop orders for you to pay
            business:write: Set up and manage your pet business on NogPets
            business:manage: Run your pet business on NogPets
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: npk_…
      description: A personal API key from the NogPets app (Profile → Connect an AI assistant). It carries the scopes chosen when it was made.