BokaMera.API.Host

ApiKeyQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
GET	/apikeys	List the API keys for the logged in user's company	Returns the API keys belonging to the company of the currently logged in user. A company administrator only ever sees the keys for their own company. Use the returned ApiKey value as the x-api-key header when calling the API (for example from an MCP server).

"use strict";
export class ApiKeyResponse {
    /** @param {{CompanyId?:string,ApiKey?:string,Active?:boolean,CreatedDate?:string,ExpiryDate?:string,ContactEmail?:string,Notes?:string,AllowedIpAddresses?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The company the API key belongs to */
    CompanyId;
    /**
     * @type {string}
     * @description The API key value to send in the x-api-key header */
    ApiKey;
    /**
     * @type {boolean}
     * @description Whether the key is active */
    Active;
    /**
     * @type {string}
     * @description When the key was created */
    CreatedDate;
    /**
     * @type {?string}
     * @description When the key expires, if ever */
    ExpiryDate;
    /**
     * @type {string}
     * @description Contact email registered for the key */
    ContactEmail;
    /**
     * @type {string}
     * @description Free text notes for the key */
    Notes;
    /**
     * @type {string}
     * @description Comma separated list of IP addresses the key is restricted to, if any */
    AllowedIpAddresses;
}
export class ApiKeyQueryResponse {
    /** @param {{ApiKeys?:ApiKeyResponse[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {ApiKeyResponse[]}
     * @description The API keys for the company */
    ApiKeys = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ApiKeyQuery {
    /** @param {{CompanyId?:string,ActiveOnly?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company to list API keys for. Defaults to the logged in user's company. Only a SuperAdmin may specify a company other than their own; for other roles this value is ignored. */
    CompanyId;
    /**
     * @type {?boolean}
     * @description If true, only return keys that are active (not cancelled and not expired). Default is false (return all). */
    ActiveOnly;
}

JavaScript ApiKeyQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /apikeys HTTP/1.1 
Host: api.bookmore.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ApiKeys":[{"Active":false,"ExpiryDate":"0001-01-01T00:00:00","ContactEmail":"String","Notes":"String","AllowedIpAddresses":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}