Gingr MCP by usefulapi is an MCP server published by io.usefulapi, hosted at gingr.usefulapi.io. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 25 tools, including gingr_list_locations, gingr_list_reservation_types, gingr_list_services_by_type, gingr_list_reference, gingr_list_reservations.
Read Gingr reservations, owners, pets, check-ins, invoices and timeclock for your pet-care business.
4,138 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
List the locations (facilities) of this Gingr app, as id (value) + name (label). Good first call: most other tools take a location_id. Gingr: GET /api/v1/get_locations.
No parameters.
{
"name": "gingr_list_locations",
"title": "List locations",
"description": "List the locations (facilities) of this Gingr app, as id (value) + name (label). Good first call: most other tools take a location_id. Gingr: GET /api/v1/get_locations.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List locations",
"readOnlyHint": true,
"openWorldHint": true
}
}List the reservation types (services such as boarding, daycare, grooming, training) with their ids. Use the ids to filter reservations or to read a type's add-on services. Gingr: GET /api/v1/reservation_types.
| Parameter | Type | Description |
|---|---|---|
| id | integer | Only this reservation type id. |
| active_only | boolean | true = only active reservation types. |
{
"name": "gingr_list_reservation_types",
"title": "List reservation types",
"description": "List the reservation types (services such as boarding, daycare, grooming, training) with their ids. Use the ids to filter reservations or to read a type's add-on services. Gingr: GET /api/v1/reservation_types.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this reservation type id.",
"exclusiveMinimum": 0
},
"active_only": {
"type": "boolean",
"description": "true = only active reservation types."
}
}
},
"annotations": {
"title": "List reservation types",
"readOnlyHint": true,
"openWorldHint": true
}
}List the additional services (add-ons) allowed for a reservation type, e.g. baths or nail trims on a boarding stay. Gingr: GET /api/v1/get_services_by_type.
| Parameter | Type | Description |
|---|---|---|
| type_id * | integer | Reservation type id (from gingr_list_reservation_types). |
| location_id | integer | Location id (from gingr_list_locations). |
{
"name": "gingr_list_services_by_type",
"title": "List add-on services of a reservation type",
"description": "List the additional services (add-ons) allowed for a reservation type, e.g. baths or nail trims on a boarding stay. Gingr: GET /api/v1/get_services_by_type.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"type_id"
],
"properties": {
"type_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Reservation type id (from gingr_list_reservation_types).",
"exclusiveMinimum": 0
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Location id (from gingr_list_locations).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List add-on services of a reservation type",
"readOnlyHint": true,
"openWorldHint": true
}
}List one kind of reference data of this Gingr app: species, breeds, temperaments, vets (veterinarians with details), retail_items (retail items for sale) or immunization_types (of one species; needs species_id). Paged. Gingr: GET /api/v1/get_species | get_breeds | get_temperaments | get_vets | get_all_retail_items | get_immunization_types.
| Parameter | Type | Description |
|---|---|---|
| kind * | string | Which list to read. |
| limit | integer | Records per page (1-200, default 50). |
| offset | integer | Skip this many records (paging; default 0). Use next_offset from the previous page. |
| species_id | integer | Species id (needed for kind=immunization_types). |
{
"name": "gingr_list_reference",
"title": "List reference data",
"description": "List one kind of reference data of this Gingr app: species, breeds, temperaments, vets (veterinarians with details), retail_items (retail items for sale) or immunization_types (of one species; needs species_id). Paged. Gingr: GET /api/v1/get_species | get_breeds | get_temperaments | get_vets | get_all_retail_items | get_immunization_types.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"kind"
],
"properties": {
"kind": {
"enum": [
"species",
"breeds",
"temperaments",
"vets",
"retail_items",
"immunization_types"
],
"type": "string",
"description": "Which list to read."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Records per page (1-200, default 50)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Skip this many records (paging; default 0). Use next_offset from the previous page."
},
"species_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Species id (needed for kind=immunization_types).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List reference data",
"readOnlyHint": true,
"openWorldHint": true
}
}List all reservations (boarding, daycare, grooming, training…) between two dates, at most 30 days apart (Gingr's limit). Paged: total, next_offset, items. Gingr: POST /api/v1/reservations (checked_in=false).
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page (1-200, default 50). |
| offset | integer | Skip this many records (paging; default 0). Use next_offset from the previous page. |
| end_date * | string | Last day (YYYY-MM-DD), at most 30 days after start_date. |
| start_date * | string | First day (YYYY-MM-DD). |
| location_id | integer | Location id (from gingr_list_locations). |
{
"name": "gingr_list_reservations",
"title": "List reservations in a date range",
"description": "List all reservations (boarding, daycare, grooming, training…) between two dates, at most 30 days apart (Gingr's limit). Paged: total, next_offset, items. Gingr: POST /api/v1/reservations (checked_in=false).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start_date",
"end_date"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Records per page (1-200, default 50)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Skip this many records (paging; default 0). Use next_offset from the previous page."
},
"end_date": {
"type": "string",
"description": "Last day (YYYY-MM-DD), at most 30 days after start_date."
},
"start_date": {
"type": "string",
"description": "First day (YYYY-MM-DD)."
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Location id (from gingr_list_locations).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List reservations in a date range",
"readOnlyHint": true,
"openWorldHint": true
}
}List the reservations that are checked in right now (the pets currently on site). Paged. Gingr: POST /api/v1/reservations (checked_in=true).
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page (1-200, default 50). |
| offset | integer | Skip this many records (paging; default 0). Use next_offset from the previous page. |
| location_id | integer | Location id (from gingr_list_locations). |
{
"name": "gingr_list_checked_in",
"title": "List pets checked in now",
"description": "List the reservations that are checked in right now (the pets currently on site). Paged. Gingr: POST /api/v1/reservations (checked_in=true).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Records per page (1-200, default 50)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Skip this many records (paging; default 0). Use next_offset from the previous page."
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Location id (from gingr_list_locations).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List pets checked in now",
"readOnlyHint": true,
"openWorldHint": true
}
}Get the summary of reservations for one date: number of check-ins, check-outs and overnights (the widget at the top of the Gingr dashboard). Gingr: GET /api/v1/reservation_widget_data.
| Parameter | Type | Description |
|---|---|---|
| date * | string | The date (YYYY-MM-DD). |
{
"name": "gingr_get_daily_summary",
"title": "Get the day's check-in / check-out summary",
"description": "Get the summary of reservations for one date: number of check-ins, check-outs and overnights (the widget at the top of the Gingr dashboard). Gingr: GET /api/v1/reservation_widget_data.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"date"
],
"properties": {
"date": {
"type": "string",
"description": "The date (YYYY-MM-DD)."
}
}
},
"annotations": {
"title": "Get the day's check-in / check-out summary",
"readOnlyHint": true,
"openWorldHint": true
}
}Get the pets checking in and checking out today at a location, by reservation type, with owner/pet names, times, run and status (Gingr's Digital Whiteboard). Gingr: GET /api/v1/back_of_house.
| Parameter | Type | Description |
|---|---|---|
| full_day | boolean | true (default) = every reservation checking in/out today; false = use mins_future. |
| type_ids * | array | Reservation type ids to include (from gingr_list_reservation_types). |
| location_id * | integer | Location id (from gingr_list_locations). |
| mins_future | integer | With full_day=false: only the next/last this many minutes. |
{
"name": "gingr_get_whiteboard",
"title": "Get today's arrivals and departures (whiteboard)",
"description": "Get the pets checking in and checking out today at a location, by reservation type, with owner/pet names, times, run and status (Gingr's Digital Whiteboard). Gingr: GET /api/v1/back_of_house.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"location_id",
"type_ids"
],
"properties": {
"full_day": {
"type": "boolean",
"description": "true (default) = every reservation checking in/out today; false = use mins_future."
},
"type_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"minItems": 1,
"description": "Reservation type ids to include (from gingr_list_reservation_types)."
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Location id (from gingr_list_locations).",
"exclusiveMinimum": 0
},
"mins_future": {
"type": "integer",
"maximum": 1440,
"minimum": 1,
"description": "With full_day=false: only the next/last this many minutes."
}
}
},
"annotations": {
"title": "Get today's arrivals and departures (whiteboard)",
"readOnlyHint": true,
"openWorldHint": true
}
}List the reservations of one owner (customer), optionally only pending requests, current, future, past or wait-listed ones, by dates, types or pets. Only the location the API user is logged into is included (Gingr). Gingr: POST /api/v1/reservations_by_owner.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Return at most this many reservations (1-200, default 50). |
| to_date | string | Only reservations up to this date (YYYY-MM-DD). |
| owner_id * | integer | Owner id (from gingr_list_owners / gingr_get_owner). |
| from_date | string | Only reservations from this date (YYYY-MM-DD). |
| animal_ids | array | Only these animal (pet) ids. |
| restrict_to | string | Only reservations in this state. |
| cancelled_only | boolean | true = only cancelled reservations. |
| completed_only | boolean | true = only completed reservations. |
| confirmed_only | boolean | true = only confirmed reservations. |
| reservation_type_ids |
List the reservations of one animal (pet), optionally only pending requests, current, future, past or wait-listed ones, by dates or types. Only the location the API user is logged into is included (Gingr). Gingr: POST /api/v1/reservations_by_animal.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Return at most this many reservations (1-200, default 50). |
| to_date | string | Only reservations up to this date (YYYY-MM-DD). |
| animal_id * | integer | Animal (pet) id (from gingr_list_animals). |
| from_date | string | Only reservations from this date (YYYY-MM-DD). |
| animal_ids | array | Only these animal (pet) ids. |
| restrict_to | string | Only reservations in this state. |
| cancelled_only | boolean | true = only cancelled reservations. |
| completed_only | boolean | true = only completed reservations. |
| confirmed_only | boolean | true = only confirmed reservations. |
| reservation_type_ids |
List the reservations that were cancelled between two dates (at most 31 days apart). Paged. Gingr: POST /api/v1/recently_cancelled_reservations.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page (1-200, default 50). |
| offset | integer | Skip this many records (paging; default 0). Use next_offset from the previous page. |
| end_date * | string | Last day of cancellation (YYYY-MM-DD). |
| start_date * | string | First day of cancellation (YYYY-MM-DD). |
| location_id | integer | Location id (from gingr_list_locations). |
{
"name": "gingr_list_cancelled_reservations",
"title": "List recently cancelled reservations",
"description": "List the reservations that were cancelled between two dates (at most 31 days apart). Paged. Gingr: POST /api/v1/recently_cancelled_reservations.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start_date",
"end_date"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Records per page (1-200, default 50)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Skip this many records (paging; default 0). Use next_offset from the previous page."
},
"end_date": {
"type": "string",
"description": "Last day of cancellation (YYYY-MM-DD)."
},
"start_date": {
"type": "string",
"description": "First day of cancellation (YYYY-MM-DD)."
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Location id (from gingr_list_locations).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List recently cancelled reservations",
"readOnlyHint": true,
"openWorldHint": true
}
}Get the estimated cost of an existing (future) reservation. Gingr: GET /api/v1/existing_reservation_estimate.
| Parameter | Type | Description |
|---|---|---|
| reservation_id * | integer | Reservation id. |
{
"name": "gingr_get_reservation_estimate",
"title": "Get a reservation's cost estimate",
"description": "Get the estimated cost of an existing (future) reservation. Gingr: GET /api/v1/existing_reservation_estimate.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"reservation_id"
],
"properties": {
"reservation_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Reservation id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get a reservation's cost estimate",
"readOnlyHint": true,
"openWorldHint": true
}
}List owners (pet parents / customers) with contact details, balance and reservation counts, optionally filtered by exact first/last name, email, cell phone, ZIP or home location. Paged. Gingr: GET /api/v1/owners (filters as params[<field>]). Passwords and payment-card references are removed.
| Parameter | Type | Description |
|---|---|---|
| zip | string | Exact ZIP / postal code. |
| string | Exact email address. | |
| limit | integer | Records per page (1-200, default 50). |
| offset | integer | Skip this many records (paging; default 0). Use next_offset from the previous page. |
| last_name | string | Exact last name. |
| cell_phone | string | Exact cell phone as stored in Gingr, e.g. (555) 555-5555. |
| first_name | string | Exact first name. |
| home_location | integer | Home location id. |
{
"name": "gingr_list_owners",
"title": "List owners (customers)",
"description": "List owners (pet parents / customers) with contact details, balance and reservation counts, optionally filtered by exact first/last name, email, cell phone, ZIP or home location. Paged. Gingr: GET /api/v1/owners (filters as params[<field>]). Passwords and payment-card references are removed.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"zip": {
"type": "string",
"maxLength": 20,
"minLength": 1,
"description": "Exact ZIP / postal code."
},
"email": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "Exact email address."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Records per page (1-200, default 50)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Skip this many records (paging; default 0). Use next_offset from the previous page."
},
"last_name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Exact last name."
},
"cell_phone": {
"type": "string",
"maxLength": 40,
"minLength": 3,
"description": "Exact cell phone as stored in Gingr, e.g. (555) 555-5555."
},
"first_name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Exact first name."
},
"home_location": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Home location id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List owners (customers)",
"readOnlyHint": true,
"openWorldHint": true
}
}Get one owner (customer) record by exactly one of: owner id, one of their pets' id, one of their reservations' id, cell phone or email. Gingr: GET /api/v1/owner. Passwords and payment-card references are removed.
| Parameter | Type | Description |
|---|---|---|
| string | Email address. | |
| phone | string | Cell phone number. |
| owner_id | integer | Owner id. |
| animal_id | integer | Find the owner of this animal (pet). |
| reservation_id | integer | Find the owner of this reservation. |
{
"name": "gingr_get_owner",
"title": "Get an owner",
"description": "Get one owner (customer) record by exactly one of: owner id, one of their pets' id, one of their reservations' id, cell phone or email. Gingr: GET /api/v1/owner. Passwords and payment-card references are removed.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "Email address."
},
"phone": {
"type": "string",
"maxLength": 40,
"minLength": 3,
"description": "Cell phone number."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Owner id.",
"exclusiveMinimum": 0
},
"animal_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Find the owner of this animal (pet).",
"exclusiveMinimum": 0
},
"reservation_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Find the owner of this reservation.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get an owner",
"readOnlyHint": true,
"openWorldHint": true
}
}List the owners (customers) created or modified between two dates (at most 366 days apart). Paged. Gingr: POST /api/v1/new_modified_owners.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page (1-200, default 50). |
| offset | integer | Skip this many records (paging; default 0). Use next_offset from the previous page. |
| end_date * | string | Last day (YYYY-MM-DD). |
| start_date * | string | First day (YYYY-MM-DD). |
| location_id | integer | Only owners whose home location is this location id. |
{
"name": "gingr_list_new_modified_owners",
"title": "List new or changed owners",
"description": "List the owners (customers) created or modified between two dates (at most 366 days apart). Paged. Gingr: POST /api/v1/new_modified_owners.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start_date",
"end_date"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Records per page (1-200, default 50)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Skip this many records (paging; default 0). Use next_offset from the previous page."
},
"end_date": {
"type": "string",
"description": "Last day (YYYY-MM-DD)."
},
"start_date": {
"type": "string",
"description": "First day (YYYY-MM-DD)."
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only owners whose home location is this location id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List new or changed owners",
"readOnlyHint": true,
"openWorldHint": true
}
}List animals (pets) with species, breed, birthday, weight, owner and notes, optionally filtered by owner, exact name, species or breed. Paged. Gingr: GET /api/v1/animals (filters as params[<field>]).
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page (1-200, default 50). |
| offset | integer | Skip this many records (paging; default 0). Use next_offset from the previous page. |
| breed_id | integer | Breed id (gingr_list_reference kind=breeds). |
| owner_id | integer | Only this owner's animals. |
| first_name | string | Exact pet name. |
| species_id | integer | Species id (gingr_list_reference kind=species). |
{
"name": "gingr_list_animals",
"title": "List animals (pets)",
"description": "List animals (pets) with species, breed, birthday, weight, owner and notes, optionally filtered by owner, exact name, species or breed. Paged. Gingr: GET /api/v1/animals (filters as params[<field>]).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Records per page (1-200, default 50)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Skip this many records (paging; default 0). Use next_offset from the previous page."
},
"breed_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Breed id (gingr_list_reference kind=breeds).",
"exclusiveMinimum": 0
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this owner's animals.",
"exclusiveMinimum": 0
},
"first_name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Exact pet name."
},
"species_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Species id (gingr_list_reference kind=species).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List animals (pets)",
"readOnlyHint": true,
"openWorldHint": true
}
}Get the immunization (vaccination) records of one animal, with expiration dates. Gingr: GET /api/v1/get_animal_immunizations.
| Parameter | Type | Description |
|---|---|---|
| animal_id * | integer | Animal (pet) id. |
{
"name": "gingr_get_animal_immunizations",
"title": "Get a pet's immunization records",
"description": "Get the immunization (vaccination) records of one animal, with expiration dates. Gingr: GET /api/v1/get_animal_immunizations.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"animal_id"
],
"properties": {
"animal_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Animal (pet) id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get a pet's immunization records",
"readOnlyHint": true,
"openWorldHint": true
}
}Get the feeding information of one animal (food, amounts, schedule). Gingr: GET /api/v1/get_feeding_info.
| Parameter | Type | Description |
|---|---|---|
| animal_id * | integer | Animal (pet) id. |
{
"name": "gingr_get_animal_feeding",
"title": "Get a pet's feeding instructions",
"description": "Get the feeding information of one animal (food, amounts, schedule). Gingr: GET /api/v1/get_feeding_info.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"animal_id"
],
"properties": {
"animal_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Animal (pet) id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get a pet's feeding instructions",
"readOnlyHint": true,
"openWorldHint": true
}
}Get the medication information of one animal (medications, doses, schedule). Gingr: GET /api/v1/get_medication_info.
| Parameter | Type | Description |
|---|---|---|
| animal_id * | integer | Animal (pet) id. |
{
"name": "gingr_get_animal_medications",
"title": "Get a pet's medications",
"description": "Get the medication information of one animal (medications, doses, schedule). Gingr: GET /api/v1/get_medication_info.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"animal_id"
],
"properties": {
"animal_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Animal (pet) id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get a pet's medications",
"readOnlyHint": true,
"openWorldHint": true
}
}List invoices (complete=true) or estimates (complete=false, Gingr's default) created on or after 2019-08-01, optionally closed only and by date range. Paged by Gingr: per_page + start (the 1-based number of the first result; the next page starts at start + per_page). Gingr: GET /api/v1/list_invoices.
| Parameter | Type | Description |
|---|---|---|
| start | integer | 1-based number of the first result (default 1; page 2 of 25 = 26). |
| to_date | string | To date (YYYY-MM-DD). |
| complete | boolean | true = invoices; false (default) = estimates. |
| per_page | integer | Results per page (1-100, default 25). |
| from_date | string | From date (YYYY-MM-DD). |
| closed_only | boolean | true = only closed invoices. |
{
"name": "gingr_list_invoices",
"title": "List invoices or estimates",
"description": "List invoices (complete=true) or estimates (complete=false, Gingr's default) created on or after 2019-08-01, optionally closed only and by date range. Paged by Gingr: per_page + start (the 1-based number of the first result; the next page starts at start + per_page). Gingr: GET /api/v1/list_invoices.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"start": {
"type": "integer",
"maximum": 10000000,
"minimum": 1,
"description": "1-based number of the first result (default 1; page 2 of 25 = 26)."
},
"to_date": {
"type": "string",
"description": "To date (YYYY-MM-DD)."
},
"complete": {
"type": "boolean",
"description": "true = invoices; false (default) = estimates."
},
"per_page": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page (1-100, default 25)."
},
"from_date": {
"type": "string",
"description": "From date (YYYY-MM-DD)."
},
"closed_only": {
"type": "boolean",
"description": "true = only closed invoices."
}
}
},
"annotations": {
"title": "List invoices or estimates",
"readOnlyHint": true,
"openWorldHint": true
}
}Get one point-of-sale transaction with its items and payment details (card numbers, processor references and auth codes are removed). Gingr: POST /api/v1/transaction.
| Parameter | Type | Description |
|---|---|---|
| transaction_id * | integer | POS transaction id. |
{
"name": "gingr_get_transaction",
"title": "Get a POS transaction",
"description": "Get one point-of-sale transaction with its items and payment details (card numbers, processor references and auth codes are removed). Gingr: POST /api/v1/transaction.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"transaction_id"
],
"properties": {
"transaction_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "POS transaction id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get a POS transaction",
"readOnlyHint": true,
"openWorldHint": true
}
}List recurring subscriptions (membership packages), optionally of one owner, location or package, by billing day, including cancelled ones if asked. Paged by Gingr (limit + offset). Gingr: GET /api/v1/get_subscriptions.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per page (1-100, default 50). |
| offset | integer | Skip this many records (paging; default 0). Use next_offset from the previous page. |
| owner_id | integer | Only this owner's subscriptions. |
| package_id | integer | Only this package. |
| location_id | integer | Location id (from gingr_list_locations). |
| include_deleted | boolean | true = include cancelled/deleted subscriptions. |
| bill_day_of_month | integer | Only subscriptions renewing on this day of the month. |
{
"name": "gingr_list_subscriptions",
"title": "List subscriptions (packages)",
"description": "List recurring subscriptions (membership packages), optionally of one owner, location or package, by billing day, including cancelled ones if asked. Paged by Gingr (limit + offset). Gingr: GET /api/v1/get_subscriptions.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Records per page (1-100, default 50)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Skip this many records (paging; default 0). Use next_offset from the previous page."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this owner's subscriptions.",
"exclusiveMinimum": 0
},
"package_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this package.",
"exclusiveMinimum": 0
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Location id (from gingr_list_locations).",
"exclusiveMinimum": 0
},
"include_deleted": {
"type": "boolean",
"description": "true = include cancelled/deleted subscriptions."
},
"bill_day_of_month": {
"type": "integer",
"maximum": 31,
"minimum": 1,
"description": "Only subscriptions renewing on this day of the month."
}
}
},
"annotations": {
"title": "List subscriptions (packages)",
"readOnlyHint": true,
"openWorldHint": true
}
}Get one subscription (membership package) by id. Gingr: GET /api/v1/get_subscription.
| Parameter | Type | Description |
|---|---|---|
| subscription_id * | integer | Subscription id. |
{
"name": "gingr_get_subscription",
"title": "Get a subscription",
"description": "Get one subscription (membership package) by id. Gingr: GET /api/v1/get_subscription.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subscription_id"
],
"properties": {
"subscription_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Subscription id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get a subscription",
"readOnlyHint": true,
"openWorldHint": true
}
}Get staff timeclock records (clock-ins/outs, hours) at a location between two dates (at most 31 days apart). Gingr: GET /api/v1/timeclock_report.
| Parameter | Type | Description |
|---|---|---|
| end_date * | string | Last day (YYYY-MM-DD). |
| user_ids | array | Only these Gingr user (staff) ids. |
| start_date * | string | First day (YYYY-MM-DD). |
| location_id * | integer | Location id (from gingr_list_locations). |
| include_deleted | boolean | true = include deleted records. |
| include_clocked_in | boolean | true = include staff still clocked in. |
{
"name": "gingr_get_timeclock_report",
"title": "Get the staff timeclock report",
"description": "Get staff timeclock records (clock-ins/outs, hours) at a location between two dates (at most 31 days apart). Gingr: GET /api/v1/timeclock_report.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start_date",
"end_date",
"location_id"
],
"properties": {
"end_date": {
"type": "string",
"description": "Last day (YYYY-MM-DD)."
},
"user_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only these Gingr user (staff) ids."
},
"start_date": {
"type": "string",
"description": "First day (YYYY-MM-DD)."
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Location id (from gingr_list_locations).",
"exclusiveMinimum": 0
},
"include_deleted": {
"type": "boolean",
"description": "true = include deleted records."
},
"include_clocked_in": {
"type": "boolean",
"description": "true = include staff still clocked in."
}
}
},
"annotations": {
"title": "Get the staff timeclock report",
"readOnlyHint": true,
"openWorldHint": true
}
}List recently uploaded report card files (photos and videos shared with pet parents), newest first. Gingr: GET /api/v1/report_card_files.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Return at most this many files (1-200, default 50). |
| location_id | integer | Location id (from gingr_list_locations). |
{
"name": "gingr_list_report_card_files",
"title": "List recent report card files",
"description": "List recently uploaded report card files (photos and videos shared with pet parents), newest first. Gingr: GET /api/v1/report_card_files.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Return at most this many files (1-200, default 50)."
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Location id (from gingr_list_locations).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List recent report card files",
"readOnlyHint": true,
"openWorldHint": true
}
}Tools for Gingr, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which pets are checked in at our facility right now, and who owns them?"; "How many check-ins and check-outs do we have today?"; "Show all boarding reservations for next week.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Gingr data. Free plan: 50 tool calls per month. Run gingr_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run gingr_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run gingr_upgrade without a plan: it returns both plans, each with a payment link for the user to open. gingr_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
| array |
| Only these reservation type ids (from gingr_list_reservation_types). |
{
"name": "gingr_list_owner_reservations",
"title": "List an owner's reservations",
"description": "List the reservations of one owner (customer), optionally only pending requests, current, future, past or wait-listed ones, by dates, types or pets. Only the location the API user is logged into is included (Gingr). Gingr: POST /api/v1/reservations_by_owner.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"owner_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Return at most this many reservations (1-200, default 50)."
},
"to_date": {
"type": "string",
"description": "Only reservations up to this date (YYYY-MM-DD)."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Owner id (from gingr_list_owners / gingr_get_owner).",
"exclusiveMinimum": 0
},
"from_date": {
"type": "string",
"description": "Only reservations from this date (YYYY-MM-DD)."
},
"animal_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"description": "Only these animal (pet) ids."
},
"restrict_to": {
"enum": [
"pending_requests",
"currently_checked_in",
"future",
"past",
"wait_listed"
],
"type": "string",
"description": "Only reservations in this state."
},
"cancelled_only": {
"type": "boolean",
"description": "true = only cancelled reservations."
},
"completed_only": {
"type": "boolean",
"description": "true = only completed reservations."
},
"confirmed_only": {
"type": "boolean",
"description": "true = only confirmed reservations."
},
"reservation_type_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"description": "Only these reservation type ids (from gingr_list_reservation_types)."
}
}
},
"annotations": {
"title": "List an owner's reservations",
"readOnlyHint": true,
"openWorldHint": true
}
}| array |
| Only these reservation type ids (from gingr_list_reservation_types). |
{
"name": "gingr_list_animal_reservations",
"title": "List a pet's reservations",
"description": "List the reservations of one animal (pet), optionally only pending requests, current, future, past or wait-listed ones, by dates or types. Only the location the API user is logged into is included (Gingr). Gingr: POST /api/v1/reservations_by_animal.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"animal_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Return at most this many reservations (1-200, default 50)."
},
"to_date": {
"type": "string",
"description": "Only reservations up to this date (YYYY-MM-DD)."
},
"animal_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Animal (pet) id (from gingr_list_animals).",
"exclusiveMinimum": 0
},
"from_date": {
"type": "string",
"description": "Only reservations from this date (YYYY-MM-DD)."
},
"animal_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"description": "Only these animal (pet) ids."
},
"restrict_to": {
"enum": [
"pending_requests",
"currently_checked_in",
"future",
"past",
"wait_listed"
],
"type": "string",
"description": "Only reservations in this state."
},
"cancelled_only": {
"type": "boolean",
"description": "true = only cancelled reservations."
},
"completed_only": {
"type": "boolean",
"description": "true = only completed reservations."
},
"confirmed_only": {
"type": "boolean",
"description": "true = only confirmed reservations."
},
"reservation_type_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"description": "Only these reservation type ids (from gingr_list_reservation_types)."
}
}
},
"annotations": {
"title": "List a pet's reservations",
"readOnlyHint": true,
"openWorldHint": true
}
}