REST API Documentation
/cms/databases/{id}
Get specific database
This endpoint is only available for requests made using an API Key or the Client Credentials Grant Type, not using an OAuth Access Token for a particular member.
Parameters
No parameters are accepted for this endpoint.
Exceptions
This endpoint doesn't throw any exceptions.
Response
Name | Type | Description |
---|---|---|
id
|
int | ID number |
name
|
string | Name |
useCategories
|
bool | If this database uses categories |
fields
|
array of fields objects | The fields |
url
|
string | URL |
permissions
|
object|null | Node permissions |
fields
object
Name | Type | Description |
---|---|---|
id
|
int | ID number |
title
|
string | Title |
description
|
string|null | Description |
type
|
string | The field type - e.g. "Text", "Editor", "Radio" |
default
|
string|null | The default value |
required
|
bool | If the field is required |
options
|
object|null | If the field has certain options (for example, it is a select field), the possible values |