{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/agencies","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"affiliateId","type":"string","default":"","desc":"The ID of the affiliate","required":false,"in":"query","ref":"","_id":"56e7b2c737afb90e00e0eb9e"}],"results":{"codes":[{"language":"json","code":"[\n  {\n    \"uid\": \"72852a55-5be3-496c-904c-fc3fd261f0a4\",\n    \"name\": \"Responseev Agency\"\n  },\n  {\n    \"uid\": \"66852a55-5483-496c-904c-fc3fbf48f0a4\",\n    \"name\": \"Haiti Agency\"\n  }\n]","name":"","status":200},{"status":400,"language":"text","code":"Orbirental API - Bad request.","name":""},{"status":409,"language":"text","code":"Orbirental API - Affiliate not found."}]},"settings":""},"next":{"description":"","pages":[]},"title":"/agencies/","type":"endpoint","slug":"agencies","excerpt":"Retrieves all agencies that the current affiliate has permission to access","body":"","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf3345","createdAt":"2016-03-15T06:59:19.402Z","editedParams2":true,"version":{"version":"1.5","version_clean":"1.5.0","codename":"Domain","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z"},"editedParams":true,"parentDoc":null,"__v":2,"project":"56e3719a591f620e00bf5095","category":{"sync":{"isSync":false,"url":""},"pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5de85dbbb0b885003ddf3334","project":"56e3719a591f620e00bf5095","__v":19,"createdAt":"2016-03-12T01:32:11.359Z","version":"5de85dbbb0b885003ddf339f"},"githubsync":"","user":"56e371538b32a10e00f79750"}

get/agencies/

Retrieves all agencies that the current affiliate has permission to access

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

affiliateId:
string
The ID of the affiliate

Result Format


User Information

Try It Out

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