NogPets Account API

The person's profile, pets and addresses.

GitHub OpenAPI

Operations 5

GET /v1/me Who am I #
GET /v1/pets The person's pets #
POST /v1/pets Add a pet #
GET /v1/addresses The person's addresses #
POST /v1/addresses Add an 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-account-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-account-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NogPets Account 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: Account
  description: The person's profile, pets and addresses.
paths:
  /v1/me:
    get:
      operationId: myProfile
      tags:
      - Account
      summary: Who am I
      security:
      - oauth2:
        - profile
      - apiKey: []
      x-scopes:
      - profile
      x-mcp-tool:
        name: my_profile
        title: The person's profile
        annotations:
          readOnlyHint: true
          destructiveHint: false
          idempotentHint: true
          openWorldHint: false
        description: 'The signed-in person''s name, email and phone, how many pets and addresses they have saved, and what this connection may do (scopes).

          Use it to greet them or to check who you''re booking for.

          '
      responses:
        '200':
          description: The profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
              example:
                uid: u-client
                name: Sam Test
                email: client@nogpets.test
                phone: '+27820000001'
                pets: 2
                addresses: 2
                client:
                  id: c_1
                  name: Claude
                scopes:
                - profile
                - pets
                - addresses
                - bookings:read
                - bookings:write
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /v1/pets:
    get:
      operationId: listPets
      tags:
      - Account
      summary: The person's pets
      security:
      - oauth2:
        - pets
      - apiKey: []
      x-scopes:
      - pets
      x-mcp-tool:
        name: list_pets
        title: The person's pets
        annotations:
          readOnlyHint: true
          destructiveHint: false
          idempotentHint: true
          openWorldHint: false
        description: 'The person''s saved pets: id, name, type, breed, weight and coat. Use a pet''s `id` as `petId` in get_quote, find_times and book.

          If the pet they mean isn''t there, ask for its type, weight and coat and add it with add_pet.

          '
      responses:
        '200':
          description: Pets
          content:
            application/json:
              schema:
                type: object
                required:
                - pets
                properties:
                  pets:
                    type: array
                    items:
                      $ref: '#/components/schemas/Pet'
              example:
                pets:
                - id: biscuit
                  name: Biscuit
                  type: DOG
                  breed: Boston terrier
                  weightKg: 8
                  coat: SHORT
                  birthYear: 2021
                  notes: Pulls on the lead.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      operationId: addPet
      tags:
      - Account
      summary: Add a pet
      security:
      - oauth2:
        - pets
      - apiKey: []
      x-scopes:
      - pets
      x-mcp-tool:
        name: add_pet
        title: Add a pet
        annotations:
          readOnlyHint: false
          destructiveHint: false
          idempotentHint: false
          openWorldHint: false
        description: 'Saves a new pet on the person''s account. Needs `name`, `type` (DOG or CAT), `weightKg` (a number; an estimate is fine) and `coat` (SHORT, MEDIUM or LONG); `breed`, `birthYear` and `notes` are optional.

          Ask the person for what you don''t know; don''t guess the weight or coat. Returns the pet with its `id` for booking.

          '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewPet'
            example:
              name: Rex
              type: DOG
              weightKg: 30
              coat: LONG
              breed: Golden retriever
      responses:
        '201':
          description: The saved pet
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /v1/addresses:
    get:
      operationId: listAddresses
      tags:
      - Account
      summary: The person's addresses
      security:
      - oauth2:
        - addresses
      - apiKey: []
      x-scopes:
      - addresses
      x-mcp-tool:
        name: list_addresses
        title: The person's addresses
        annotations:
          readOnlyHint: true
          destructiveHint: false
          idempotentHint: true
          openWorldHint: false
        description: 'The person''s saved addresses (label such as Home, street, suburb, notes like a gate code). Use an address''s `id` as `addressId` in get_quote, find_times and book.

          If they want a visit somewhere new, save it with add_address.

          '
      responses:
        '200':
          description: Addresses
          content:
            application/json:
              schema:
                type: object
                required:
                - addresses
                properties:
                  addresses:
                    type: array
                    items:
                      $ref: '#/components/schemas/Address'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      operationId: addAddress
      tags:
      - Account
      summary: Add an address
      security:
      - oauth2:
        - addresses
      - apiKey: []
      x-scopes:
      - addresses
      x-mcp-tool:
        name: add_address
        title: Add an address
        annotations:
          readOnlyHint: false
          destructiveHint: false
          idempotentHint: false
          openWorldHint: false
        description: 'Saves an address on the person''s account. Needs `label` (e.g. Home) and `line1` (house number and street), and the suburb or postal code (in `suburb`/`postalCode`, or inside `line1`; abroad, `city` and the country in `line1` or `city`); `lat`/`lng` if you have the exact point; `notes` for a gate code or where to park.

          Returns the address with its `id` and which service lines cover it. `UNKNOWN_PLACE` means the suburb or postal code wasn''t recognised: ask the person for it.

          '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewAddress'
            example:
              label: Home
              line1: 14 Kromrivier Street
              suburb: Die Boord
              postalCode: '7613'
              notes: Gate code 1234
      responses:
        '201':
          description: The saved address and its coverage
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Address'
                - type: object
                  required:
                  - covered
                  - lines
                  properties:
                    covered:
                      type: boolean
                    lines:
                      type: array
                      items:
                        $ref: '#/components/schemas/LineCoverage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/Unprocessable'
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
    Address:
      type: object
      required:
      - id
      - label
      - line1
      properties:
        id:
          type: string
        label:
          type: string
        line1:
          type: string
        suburb:
          type: string
        city:
          type: string
        postalCode:
          type: string
        notes:
          type: string
        isDefault:
          type: boolean
    Coat:
      type: string
      enum:
      - SHORT
      - MEDIUM
      - LONG
    Pet:
      type: object
      required:
      - id
      - name
      - type
      - weightKg
      - coat
      properties:
        id:
          type: string
        name:
          type: string
        type:
          $ref: '#/components/schemas/PetType'
        breed:
          type: string
        weightKg:
          type: number
        coat:
          $ref: '#/components/schemas/Coat'
        birthYear:
          type:
          - integer
          - 'null'
        notes:
          type: string
    Profile:
      type: object
      required:
      - uid
      - name
      - scopes
      properties:
        uid:
          type: string
        name:
          type: string
        email:
          type: string
        phone:
          type: string
        pets:
          type: integer
        addresses:
          type: integer
        client:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
        scopes:
          type: array
          items:
            type: string
    NewAddress:
      type: object
      additionalProperties: false
      required:
      - label
      - line1
      properties:
        label:
          type: string
          minLength: 1
          maxLength: 40
        line1:
          type: string
          minLength: 1
          maxLength: 200
        suburb:
          type: string
          maxLength: 80
        city:
          type: string
          maxLength: 80
        postalCode:
          type: string
          pattern: ^[A-Za-z0-9][A-Za-z0-9 -]{1,9}$
        lat:
          type: number
          minimum: -90
          maximum: 90
        lng:
          type: number
          minimum: -180
          maximum: 180
        notes:
          type: string
          maxLength: 500
        isDefault:
          type: boolean
    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
    NewPet:
      type: object
      additionalProperties: false
      required:
      - name
      - type
      - weightKg
      - coat
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 60
        type:
          $ref: '#/components/schemas/PetType'
        weightKg:
          type: number
          exclusiveMinimum: 0
          exclusiveMaximum: 120
        coat:
          $ref: '#/components/schemas/Coat'
        breed:
          type: string
          maxLength: 80
        birthYear:
          type: integer
          minimum: 1990
          maximum: 2100
        notes:
          type: string
          maxLength: 1000
  responses:
    Unauthorized:
      description: No token, or it's expired or revoked. The `WWW-Authenticate` header points at the resource metadata.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHENTICATED
              message: A NogPets access token or API key is needed.
    Forbidden:
      description: The token lacks a scope (`INSUFFICIENT_SCOPE`, with `details.scope`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INSUFFICIENT_SCOPE
              message: This needs the bookings:write scope.
              details:
                scope: bookings:write
    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
    Unprocessable:
      description: The place couldn't be recognised (`UNKNOWN_PLACE`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  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.