Get swagger docs for an object.

https://cloud-elements.com/objects/{objectName}/docs

Access Token Required: API Key

Path Parameters

objectNamestringrequired

The name of the object

Query Params

discoverystring

Include discovery metadata in definitions

resolveReferencesstring

Optionally resolve swagger references for an inline object definition

basicstring

Include only OpenAPI / Swagger properties in definitions

versionstring

The element swagger version to get the corresponding element swagger, Passing in "-1" gives latest element swagger

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://cloud-elements.com/objects/{objectName}/docs' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET