action ideal_postcodes_retrieve_licensee { label: "Retrieve" description: "Returns licensee information as identified by the licensee key." provider: ideal_postcodes method: GET path: "/keys/{key}/licensees/{licensee}" encoding: json input: { type: "object" properties: { key: { type: "string" description: "Your API Key. Typically beings `ak_`.\n\nAvailable from your dashboard\n" } licensee: { type: "string" description: "Uniquely identifies a licensee\n" } 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", "licensee"] 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" } } } }