API reference Wikis
List wikis
get/v1/wikis
Returns the wikis in an account that the key owner can open.
Query parameters
| Parameter | Description |
|---|---|
account_idstring (uuid)required | The account to list wikis for. |
Responses
- 200
The wikis.
Fields of the 200 response of List wikis Field Description objectstringAlways
"list".dataobject[]data[].objectstringAlways
"wiki".data[].idstring (uuid)The wiki ID.
data[].account_idstring (uuid)The account the wiki belongs to.
data[].namestringdata[].slugstringThe wiki part of its SlimWiki URL.
data[].is_privatebooleanPrivate wikis are visible to members only.
data[].updated_atstring (date-time) | nulloptionalWhen the wiki settings last changed.
has_morebooleanWhether another page of results exists after this one.
- 400
account_idis missing or not a valid ID. Error code:invalid_request.Error body fields
Fields of the 400 error body of List wikis Field Description errorobjecterror.codestringA stable, machine-readable error code.
One of
invalid_request,unauthorized,insufficient_scope,forbidden,not_found,conflict,rate_limited,internal_error.error.messagestringA description for people. The wording may change.
error.detailsobject[]optionalFor
invalid_request: the fields that failed validation.error.details[].fieldstringoptionalerror.details[].messagestringoptionalerror.request_idstring | nulloptionalQuote this when contacting support.
- 401
The API key is missing, invalid, revoked or expired. Error code:
unauthorized.Error body fields
Fields of the 401 error body of List wikis Field Description errorobjecterror.codestringA stable, machine-readable error code.
One of
invalid_request,unauthorized,insufficient_scope,forbidden,not_found,conflict,rate_limited,internal_error.error.messagestringA description for people. The wording may change.
error.detailsobject[]optionalFor
invalid_request: the fields that failed validation.error.details[].fieldstringoptionalerror.details[].messagestringoptionalerror.request_idstring | nulloptionalQuote this when contacting support.
- 404
The resource does not exist, or this API key cannot see it. Error code:
not_found.Error body fields
Fields of the 404 error body of List wikis Field Description errorobjecterror.codestringA stable, machine-readable error code.
One of
invalid_request,unauthorized,insufficient_scope,forbidden,not_found,conflict,rate_limited,internal_error.error.messagestringA description for people. The wording may change.
error.detailsobject[]optionalFor
invalid_request: the fields that failed validation.error.details[].fieldstringoptionalerror.details[].messagestringoptionalerror.request_idstring | nulloptionalQuote this when contacting support.
- 429
Rate limit exceeded. See the
Retry-Afterheader. Error code:rate_limited.Error body fields
Fields of the 429 error body of List wikis Field Description errorobjecterror.codestringA stable, machine-readable error code.
One of
invalid_request,unauthorized,insufficient_scope,forbidden,not_found,conflict,rate_limited,internal_error.error.messagestringA description for people. The wording may change.
error.detailsobject[]optionalFor
invalid_request: the fields that failed validation.error.details[].fieldstringoptionalerror.details[].messagestringoptionalerror.request_idstring | nulloptionalQuote this when contacting support.
Any request can also fail with 500 internal_error. See Errors for every code.