GET /v1/tools/docs

HTTP Method: GET

Path: /v1/tools/docs

Authentication: API Key required

Description: Get up-to-date information about the structure of objects that can be found in an entity 

Parameters:

parameter type description
object ENUM  Required - One of name, invoice_address, postal_address, phone, fax, category, tag, geopoint, advertiser, email, website,i mage, logo, status, description, video, affiliate_link, list, document, testimonial, opening_times, special_offer, employee
format ENUM Optional - json, html. Default is json

Sample Response:

{
     "success": true,    
     "msg": "Success - Method documentation returned",
     "data": {
         "parameters": [
             {
                 "attribute_name": "name",
                 "type": "string",
                 "required": true,
                 "must_match": "",
                 "max_length": "",
                 "default_value": "",
                 "example": "",
                 "minimum_value": "",
                 "maximum_value": "",
                 "description": ""
             },
             {
                 "attribute_name": "formal_name",
                 "type": "string",
                 "required": false,
                 "must_match": "",
                 "max_length": "",
                 "default_value": "",
                 "example": "",
                 "minimum_value": "",
                 "maximum_value": "",
                 "description": ""
             }
         ]
     }
 }

The API call returns all the attributes that an object can have, and a description for each one of them (such as what type of field it is, what input is accepted or any examples of valid input)

version 3 as of 6 years ago by Unknown

Docs Navigation