Base requests

Get attributes of an entity

This requests available for many of endpoints. Don't forget to replace example endpoint /example/entity/endpoint to what you need.Get attributes list of an entity.

get/example/entity/endpoint

Request

Base URL: https://demo.splynx.com/api/2.0
URL: https://demo.splynx.com/api/2.0/example/entity/endpoint
Auth: HTTP basic

Response

namestring

Attribute name

titlestring

Attribute title

typestring

Attribute type

requiredboolean

Is this attribute required

Example response

[
  {
    "name": "module",
    "title": "Module name",
    "type": "string",
    "required": true
  },
  {
    "name": "ip",
    "title": "Example additional attribute",
    "type": "string",
    "required": true,
    "module": "paypal",
    "category": 0,
    "position": 6,
    "decimals": 2,
    "is_unique": false,
    "is_add": false,
    "show_in_list": true,
    "searchable": true,
    "readonly": false,
    "disabled": false,
    "hidden": false,
    "set_default_value": true
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.