Artashippinginc · Schema

HostedSession

Company

Properties

Name Type Description
additional_services array Any desired services, such as unpacking, installation, etc. can be sent through in the request and will be treated as if that requested service is required. Requested services may disqualify certain s
can_user_confirm_object_dimensions boolean Determines whether your customer can verify and update object dimension information when completing an inbound booking session.
cancel_url string The URL the user will be redirected to after an Arta Booking session is cancelled
created_at string
customs_end_use string The intended end use of the items being shipped for customs purposes
customs_process string The customs process for the shipment. "ddu" (Delivery Duties Unpaid) means the receiver is responsible for paying duties and taxes. "ddp" (Delivery Duties Paid) means the sender prepays duties and tax
destination object
id integer
insurance stringnull The id of an insurance type. If requesting Arta insurance, object values must be provided.
internal_reference stringnull This field can be used to pass through any data about the request you may want returned unaltered for your own later usage
objects array A list of objects to be shipped
origin object
payment_process string The primary method by which payment to Arta will be handled for any shipment booked through this hosted session
preferred_parcel_transport_services arraynull Optionally instruct the Arta API to filter Parcel and Self Ship quotes for specific transport services. For example, if you would prefer to only return `ground` quotes, you can set this field to `["gr
preferred_quote_types array An optional field presenting the list of quote types the caller instructed Arta to return as part of the hosted session
private_token string A private access token for this resource. It is used to generate the private URL for the hosted session
public_instructions_booking_review string A client defined multi-line block of text presented to users in the quote review modal window prior to booking a shipment for booking, shared request, and inbound booking sessions. - Supports multiple
public_instructions_confirmation string A client defined multi-line block of text presented to users on the post-shipment booking confirmation view for booking, shared request, and inbound booking hosted sessions. - Supports multiple lines
public_instructions_location_quotes string A client defined multi-line block of text presented to users on the location and quote selection view for booking, shared request, and inbound booking hosted sessions. - Supports multiple lines and ma
public_instructions_object_details string A client defined multi-line block of text presented to users on the object form in inbound booking hosted sessions. - Only visible if `can_user_confirm_object_dimensions` is true - Supports multiple l
public_instructions_payment string A client defined multi-line block of text presented to users on the post-shipment booking payment view when required for booking, shared request, and inbound booking hosted sessions. - Supports multip
public_reference stringnull A client defined name for the resource. The value provided for the public_reference field may appear in notification emails and public web pages
quoting_strategy string The quoting strategy used when creating quote requests for this booking session. Determines whether the API returns a single best-rate option per transport speed or multiple carrier options for compar
shipping_notes stringnull This field can be used to pass through any notes to Arta that a customer might want to provide about the request
shortcode string A brief and unique string identifier for the resource
status string
success_url string The URL the user will be redirected to after an Arta Booking session is completed
tags array A list of tags associated with this hosted session
type string The type of the hosted session
updated_at string
url stringnull The Arta Booking web URL for this Hosted Session
View JSON Schema on GitHub

JSON Schema

artashippinginc-hosted-session-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/artashippinginc/main/json-schema/artashippinginc-hosted-session-schema.json",
  "title": "HostedSession",
  "x-generated": "2026-09-26",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/arta-openapi.json#/components/schemas/HostedSession",
  "properties": {
    "additional_services": {
      "description": "Any desired services, such as unpacking, installation, etc. can be sent through in the request and will be treated as if that requested service is required. Requested services may disqualify certain segments of shipping services offered by Arta depending on location and object details.",
      "items": {
        "description": "The id of a service.",
        "type": "string",
        "x-struct": null,
        "x-validate": null
      },
      "type": "array",
      "x-struct": null,
      "x-validate": null
    },
    "can_user_confirm_object_dimensions": {
      "description": "Determines whether your customer can verify and update object dimension information when completing an inbound booking session.",
      "type": "boolean",
      "x-struct": null,
      "x-validate": null
    },
    "cancel_url": {
      "description": "The URL the user will be redirected to after an Arta Booking session is cancelled",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "created_at": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "customs_end_use": {
      "description": "The intended end use of the items being shipped for customs purposes",
      "enum": [
        "for_resale",
        "not_for_resale"
      ],
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "customs_process": {
      "description": "The customs process for the shipment. \"ddu\" (Delivery Duties Unpaid) means the receiver is responsible for paying duties and taxes. \"ddp\" (Delivery Duties Paid) means the sender prepays duties and taxes. \"ddp_optional\" means the receiver will decide whether to pay estimated duties, fees, and taxes prior to fulfillment",
      "enum": [
        "ddu",
        "ddp",
        "ddp_optional"
      ],
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "destination": {
      "$ref": "#/$defs/NullableLocation"
    },
    "id": {
      "format": "int64",
      "type": "integer",
      "x-struct": null,
      "x-validate": null
    },
    "insurance": {
      "description": "The id of an insurance type. If requesting Arta insurance, object values must be provided.",
      "type": [
        "string",
        "null"
      ],
      "x-struct": null,
      "x-validate": null
    },
    "internal_reference": {
      "description": "This field can be used to pass through any data about the request you may want returned unaltered for your own later usage",
      "maxLength": 255,
      "type": [
        "string",
        "null"
      ],
      "x-struct": null,
      "x-validate": null
    },
    "objects": {
      "description": "A list of objects to be shipped",
      "items": {
        "$ref": "#/$defs/Object"
      },
      "type": "array",
      "x-struct": null,
      "x-validate": null
    },
    "origin": {
      "$ref": "#/$defs/Location"
    },
    "payment_process": {
      "description": "The primary method by which payment to Arta will be handled for any shipment booked through this hosted session",
      "enum": [
        "checkout",
        "invoicing"
      ],
      "readOnly": true,
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "preferred_parcel_transport_services": {
      "description": "Optionally instruct the Arta API to filter Parcel and Self Ship quotes for specific transport services. For example, if you would prefer to only return `ground` quotes, you can set this field to `[\"ground\"]` The list of valid transport service IDs is available at the /metadata/parcel_transport_services endpoint.",
      "items": {
        "type": "string",
        "x-struct": null,
        "x-validate": null
      },
      "type": [
        "array",
        "null"
      ],
      "x-struct": null,
      "x-validate": null
    },
    "preferred_quote_types": {
      "description": "An optional field presenting the list of quote types the caller instructed Arta to return as part of the hosted session",
      "items": {
        "type": "string",
        "x-struct": null,
        "x-validate": null
      },
      "type": "array",
      "x-struct": null,
      "x-validate": null
    },
    "private_token": {
      "description": "A private access token for this resource. It is used to generate the private URL for the hosted session",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "public_instructions_booking_review": {
      "description": "A client defined multi-line block of text presented to users in the quote review modal window prior to booking a shipment for booking, shared request, and inbound booking sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "public_instructions_confirmation": {
      "description": "A client defined multi-line block of text presented to users on the post-shipment booking confirmation view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "public_instructions_location_quotes": {
      "description": "A client defined multi-line block of text presented to users on the location and quote selection view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "public_instructions_object_details": {
      "description": "A client defined multi-line block of text presented to users on the object form in inbound booking hosted sessions.\n\n- Only visible if `can_user_confirm_object_dimensions` is true\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "public_instructions_payment": {
      "description": "A client defined multi-line block of text presented to users on the post-shipment booking payment view when required for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "public_reference": {
      "description": "A client defined name for the resource. The value provided for the public_reference field may appear in notification emails and public web pages",
      "maxLength": 255,
      "type": [
        "string",
        "null"
      ],
      "x-struct": null,
      "x-validate": null
    },
    "quoting_strategy": {
      "default": "best_rate",
      "description": "The quoting strategy used when creating quote requests for this booking session. Determines whether the API returns a single best-rate option per transport speed or multiple carrier options for comparison",
      "enum": [
        "best_rate",
        "compare_carriers"
      ],
      "maxLength": 255,
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "shipping_notes": {
      "description": "This field can be used to pass through any notes to Arta that a customer might want to provide about the request",
      "type": [
        "string",
        "null"
      ],
      "x-struct": null,
      "x-validate": null
    },
    "shortcode": {
      "description": "A brief and unique string identifier for the resource",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "status": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "success_url": {
      "description": "The URL the user will be redirected to after an Arta Booking session is completed",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "tags": {
      "description": "A list of tags associated with this hosted session",
      "items": {
        "$ref": "#/$defs/Tag"
      },
      "type": "array",
      "x-struct": null,
      "x-validate": null
    },
    "type": {
      "description": "The type of the hosted session",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "updated_at": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "url": {
      "description": "The Arta Booking web URL for this Hosted Session",
      "type": [
        "string",
        "null"
      ],
      "x-struct": null,
      "x-validate": null
    }
  },
  "type": "object",
  "x-struct": "Elixir.DocsWeb.Schemas.Response.HostedSession",
  "x-validate": null,
  "$defs": {
    "Currency": {
      "default": "USD",
      "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint",
      "maxLength": 3,
      "minLength": 3,
      "pattern": "^[A-Z]{3}$",
      "title": "Currency",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "Location": {
      "properties": {
        "access_restrictions": {
          "deprecated": true,
          "items": {
            "description": "Id of location restriction type",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "address_line_1": {
          "description": "First line of address",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "address_line_2": {
          "description": "Second line of address",
          "type": [
            "string",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        },
        "address_line_3": {
          "description": "Third line of address",
          "type": [
            "string",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        },
        "city": {
          "description": "City",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "contacts": {
          "description": "A list of contacts at the location",
          "items": {
            "properties": {
              "email_address": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "name": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "phone_number": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              }
            },
            "required": [
              "name"
            ],
            "type": "object",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "country": {
          "description": "The ISO 3166-1 alpha-2 country code of the current or last known location if available",
          "maxLength": 2,
          "minLength": 2,
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "postal_code": {
          "description": "The postal code",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "region": {
          "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "title": {
          "description": "The title or name of the location",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        }
      },
      "required": [
        "country"
      ],
      "title": "Location",
      "type": "object",
      "x-struct": "Elixir.DocsWeb.Schemas.Response.Location",
      "x-validate": null
    },
    "MonetaryAmount": {
      "pattern": "^(0|([1-9]+[0-9]*))(\\.[0-9]{1,2})?$",
      "title": "MonetaryAmount",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "NullableLocation": {
      "properties": {
        "access_restrictions": {
          "items": {
            "description": "Id of location restriction type",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "address_line_1": {
          "description": "First line of address",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "address_line_2": {
          "description": "Second line of address",
          "type": [
            "string",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        },
        "address_line_3": {
          "description": "Third line of address",
          "type": [
            "string",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        },
        "city": {
          "description": "City",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "contacts": {
          "description": "An list of contacts at the location",
          "items": {
            "properties": {
              "email_address": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "name": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "phone_number": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              }
            },
            "type": "object",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "country": {
          "description": "The ISO 3166-1 alpha-2 country code of the current or last known location if available",
          "maxLength": 2,
          "minLength": 2,
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "id": {
          "description": "The location id",
          "readOnly": true,
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "postal_code": {
          "description": "The postal code",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "region": {
          "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "title": {
          "description": "The title or name of the location",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        }
      },
      "title": "NullableLocation",
      "type": [
        "object",
        "null"
      ],
      "x-struct": "Elixir.DocsWeb.Schemas.Response.NullableLocation",
      "x-validate": null
    },
    "Object": {
      "properties": {
        "components": {
          "description": "A list of components in the object. Should be used only with a `prepacked_box` object subtype.\n\nWhen components are present, the object value must equal the sum of component values.",
          "items": {
            "properties": {
              "customs": {
                "properties": {
                  "country_of_origin": {
                    "description": "The ISO 3166-1 alpha-2 country code where the object was made or manufactured",
                    "maxLength": 2,
                    "minLength": 2,
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "hs_code": {
                    "description": "The Harmonized System code for the object. This is a 6-10 digit code used to classify traded products",
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "medium": {
                    "description": "The medium of the object. This is a description of the material or materials used to create the object",
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "temporary_admission": {
                    "description": "Select true if the goods are currently in the country under a temporary admission declaration",
                    "type": "boolean",
                    "x-struct": null,
                    "x-validate": null
                  }
                },
                "type": "object",
                "x-struct": null,
                "x-validate": null
              },
              "details": {
                "properties": {
                  "creation_date": {
                    "description": "Details about the timing in which an object was created",
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "creator": {
                    "description": "The creator of the object",
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "notes": {
                    "description": "Any notes about the item",
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "title": {
                    "description": "The object title",
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  }
                },
                "type": "object",
                "x-struct": null,
                "x-validate": null
              },
              "id": {
                "description": "The id of the component in UUID format",
                "format": "uuid",
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "internal_reference": {
                "description": "This field can be used to pass through any data that you may want returned unaltered for your own later usage",
                "maxLength": 255,
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "public_reference": {
                "description": "A client defined name for the object. The value provided for public_reference may be presented in notification emails and on shipment detail pages",
                "maxLength": 255,
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "type": {
                "description": "The object component type ID. Options are defined in the Object Component types metadata endpoint",
                "pattern": "^[0-9a-z_]{1,56}$",
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "value": {
                "$ref": "#/$defs/MonetaryAmount"
              },
              "value_currency": {
                "$ref": "#/$defs/Currency"
              }
            },
            "type": "object",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "current_packing": {
          "description": "A list of packing subtype IDs describing how the item is currently packed",
          "items": {
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "customs": {
          "properties": {
            "country_of_origin": {
              "description": "The ISO 3166-1 alpha-2 country code where the object was made or manufactured",
              "maxLength": 2,
              "minLength": 2,
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "hs_code": {
              "description": "The Harmonized System code for the object. This is a 6-10 digit code used to classify traded products",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "medium": {
              "description": "The medium of the object. This is a description of the material or materials used to create the object",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "temporary_admission": {
              "description": "Select true if the goods are currently in the country under a temporary admission declaration",
              "type": "boolean",
              "x-struct": null,
              "x-validate": null
            }
          },
          "type": "object",
          "x-struct": null,
          "x-validate": null
        },
        "depth": {
          "description": "The depth of the object",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "details": {
          "properties": {
            "creation_date": {
              "description": "Details about the timing in which an object was created",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "creator": {
              "description": "The creator of the object",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "is_cites": {
              "default": false,
              "description": "Set to true if the object is governed by the Convention on International Trade in Endangered Species of Wild Fauna and Flora",
              "type": "boolean",
              "x-struct": null,
              "x-validate": null
            },
            "is_fragile": {
              "default": false,
              "description": "Set this flag to true is the item is fragile. This may effect packing and handling costs",
              "type": "boolean",
              "x-struct": null,
              "x-validate": null
            },
            "materials": {
              "deprecated": true,
              "description": "A list of IDs describing the types of materials used",
              "items": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "type": "array",
              "x-struct": null,
              "x-validate": null
            },
            "notes": {
              "description": "Any notes about the item",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "title": {
              "description": "The object title",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            }
          },
          "type": "object",
          "x-struct": null,
          "x-validate": null
        },
        "height": {
          "description": "The height of the object",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "id": {
          "format": "int64",
          "type": "integer",
          "x-struct": null,
          "x-validate": null
        },
        "images": {
          "description": "A list image urls of the object",
          "items": {
            "format": "uri",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "internal_reference": {
          "description": "This field can be used to pass through any data that you may want returned unaltered for your own later usage",
          "maxLength": 255,
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "public_reference": {
          "description": "A client defined name for the object. The value provided for public_reference may be presented in notification emails and on shipment detail pages",
          "maxLength": 255,
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "subtype": {
          "description": "The object subtype ID. Options are defined in the Object types metadata endpoint",
          "pattern": "^[0-9a-z_]{1,56}$",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "type": {
          "description": "The object type id",
          "pattern": "^[0-9a-z_]{1,56}$",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "unit_of_measurement": {
          "enum": [
            "in",
            "cm"
          ],
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "value": {
          "$ref": "#/$defs/MonetaryAmount"
        },
        "value_currency": {
          "$ref": "#/$defs/Currency"
        },
        "weight": {
          "description": "The weight of the object",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "weight_unit": {
          "description": "The unit of the object",
          "enum": [
            "lb",
            "kg"
          ],
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "width": {
          "description": "The width of the object",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        }
      },
      "title": "Object",
      "type": "object",
      "x-struct": "Elixir.DocsWeb.Schemas.Response.Object",
      "x-validate": null
    },
    "Tag": {
      "properties": {
        "color": {
          "description": "The hexadecimal color code for the tag, without the leading `#`.",
          "maxLength": 6,
          "minLength": 6,
          "pattern": "^[0-9A-F]{6}$",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "created_at": {
          "description": "A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision",
          "format": "date-time",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "created_by": {
          "description": "The user ID associated with the user who created the tag when applicable.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        },
        "description": {
          "description": "An optional, brief description for this tag.",
          "maxLength": 255,
          "type": [
            "string",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        },
        "id": {
          "description": "The id of the tag in UUID format",
          "format": "uuid",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "is_active": {
          "description": "Indicates whether or not the tag is active. Inactive tags may not be associated to new resources",
          "type": "boolean",
          "x-struct": null,
          "x-validate": null
        },
        "name": {
          "description": "The name for the tag. It may contain lower case letters, dashes, and alphanumeric characters only. The maximum character count is 50.",
          "maxLength": 50,
          "pattern": "^[a-z0-9-]{1,50}$",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "updated_at": {
          "description": "A NaiveDatetime-formatted timestamp describing when the resource was last updated with microsecond precision",
          "format": "date-time",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "updated_by": {
          "description": "The user ID associated with the last user to edit the tag when applicable.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        }
      },
      "title": "Tag",
      "type": "object",
      "x-struct": "Elixir.DocsWeb.Schemas.Response.Tag",
      "x-validate": null
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/artashippinginc-hosted-session"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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. See our Privacy Policy and Terms.

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