v1
latestOpenAPI 3.0.32026-07-24614422630.2 KBAuthentication
Create a new api key
Create a new api key with the specified parameters. The new key is returned
post/apikey
Query parameters
role'ADMIN' | 'FINANCE' | 'SALES' | 'DEAL_DESK' | 'BILLING_CLERK' | 'REVENUE_CLERK' | 'READ_ONLY' | 'EXECUTIVE' | 'CRM' | 'IMPORT'
Role-based permissions to be associated with the key. Specify this OR userId.
expiryinteger
Time of expiry in seconds since Epoch (GMT)
userIdstring
User to associate key with. Specify this OR role.
entityIdstring
Scope of entities that the key has access to. Either specify a single entity or all entities (i.e. *).
Response
successful operation
string required