API Docs

Get URL

Get URL - kintone.api.url()

Returns a URL from a shortened API path.

Function

kintone.api.url(path, isGuestSpace)

Request Parameters

Parameter Type Required Description
path String Yes The Kintone REST API or User API path.
Specify the path by omitting the base URL.
For example, if the API URL is https://{subdomain}.kintone.com/k/v1/records.json, then specify the parameter as /k/v1/records. If the .json extension is ignored, it will be automatically appended to the returned URL.
isGuestSpace Boolean Optional Whether to get the URL for a guest space.
  • true: Gets the URL for a guest space
  • false: Gets the normal URL
If ignored, it will be set to false.
If set to true and the function runs in a guest space, the URL for the guest space will be returned.

Returns

A URL string.

Available Pages