action ideal_postcodes_list_licensees {
  label: "List"
  description: "Returns a list of licensees for a key."
  provider: ideal_postcodes
  method: GET
  path: "/keys/{key}/licensees"
  encoding: json
  input: {
    type: "object"
    properties: {
      key: {
        type: "string"
        description: "Your API Key. Typically beings `ak_`.\n\nAvailable from your dashboard\n"
      }
      limit: {
        type: "integer"
        format: "int32"
        description: "Specifies the maximum number of suggestions to retrieve.\n\nBy default the limit is 10, unless a postcode is queried (then all addresses at that postcode will be returned). Limit can be shortened to `l=`\n"
      }
      query: {
        type: "string"
      }
      starting_after: {
        type: "integer"
        format: "int32"
      }
      user_token: {
        type: "string"
        description: "A secret key used for sensitive operations on your account and API Keys.\n\nYour user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account).\n\nTypically beings `uk_...`\n"
      }
    }
    required: ["key"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["code", "message", "result"]
    properties: {
      code: {
        type: "integer"
        format: "int32"
        enum: [2000]
      }
      message: {
        type: "string"
        enum: ["Success"]
      }
      result: {
        type: "object"
        description: "List of licensees"
        properties: {
          hasMore: {
            type: "boolean"
            description: "Returns true if there are more licensees listed after the maximum number of results as implied by `limit`"
          }
          licensees: {
            type: "array"
            items: {
              type: "object"
            }
          }
        }
      }
    }
  }
}