{"_id":"5de85dbbb0b885003ddf339e","project":"56e3719a591f620e00bf5095","version":{"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"Domain","version_clean":"1.5.0","version":"1.5"},"category":{"_id":"5de85dbbb0b885003ddf3334","pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"5de85dbbb0b885003ddf339f","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"user":"56e371538b32a10e00f79750","__v":3,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-12-04T15:04:27.063Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[{"name":"","code":"{\n    \"name\": \"externalURL\",\n    \"id\": 34,\n    \"type\": \"TEXT\"\n}","language":"json","status":200},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"code":"Orbirental API - Property not found.","language":"text","status":409}]},"settings":"","auth":"required","params":[{"_id":"56e75cbb5669091700c5b2b2","ref":"","in":"body","required":true,"desc":"The unique ID of the agency","default":"","type":"string","name":"agencyUid"},{"_id":"5de7cafb95ab6b0051f94ec4","ref":"","in":"body","required":true,"desc":"Name of the custom data field","default":"","type":"string","name":"name"},{"_id":"5de7cafb95ab6b0051f94ec3","ref":"","in":"body","required":false,"desc":"Type of the custom data field (can be TEXT / LONG_TEXT)","default":"TEXT","type":"string","name":"type"}],"url":"/customdatafields/"},"isReference":false,"order":13,"body":"","excerpt":"Retrieve the custom data fields associated to the agency","slug":"customdatafields","type":"endpoint","title":"/customdatafields/"}

post/customdatafields/

Retrieve the custom data fields associated to the agency

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

agencyUid:
required
string
The unique ID of the agency
name:
required
string
Name of the custom data field
type:
stringTEXT
Type of the custom data field (can be TEXT / LONG_TEXT)

Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}