| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| 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). |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@ApiResponse(Description="Returned if the current user is not authenticated", StatusCode=401)
// @ApiResponse(Description="Returned if the current user does not have the required role", StatusCode=403)
open class ApiKeyQuery : ICompany
{
/**
* 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.
*/
@ApiMember(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.", ParameterType="query")
override var CompanyId:UUID? = null
/**
* If true, only return keys that are active (not cancelled and not expired). Default is false (return all).
*/
@ApiMember(DataType="boolean", Description="If true, only return keys that are active (not cancelled and not expired). Default is false (return all).", ParameterType="query")
open var ActiveOnly:Boolean? = null
}
open class ApiKeyQueryResponse
{
/**
* The API keys for the company
*/
@ApiMember(Description="The API keys for the company")
open var ApiKeys:ArrayList<ApiKeyResponse> = ArrayList<ApiKeyResponse>()
open var ResponseStatus:ResponseStatus? = null
}
open class ApiKeyResponse
{
/**
* The company the API key belongs to
*/
@ApiMember(Description="The company the API key belongs to")
open var CompanyId:UUID? = null
/**
* The API key value to send in the x-api-key header
*/
@ApiMember(Description="The API key value to send in the x-api-key header")
open var ApiKey:UUID? = null
/**
* Whether the key is active
*/
@ApiMember(Description="Whether the key is active")
open var Active:Boolean? = null
/**
* When the key was created
*/
@ApiMember(Description="When the key was created")
open var CreatedDate:Date? = null
/**
* When the key expires, if ever
*/
@ApiMember(Description="When the key expires, if ever")
open var ExpiryDate:Date? = null
/**
* Contact email registered for the key
*/
@ApiMember(Description="Contact email registered for the key")
open var ContactEmail:String? = null
/**
* Free text notes for the key
*/
@ApiMember(Description="Free text notes for the key")
open var Notes:String? = null
/**
* Comma separated list of IP addresses the key is restricted to, if any
*/
@ApiMember(Description="Comma separated list of IP addresses the key is restricted to, if any")
open var AllowedIpAddresses:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}