API documentation

Examples

GET /api/organizations
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2021-05-18 16:01:28 UTC",
      "updated_at": "2021-05-18 16:01:28 UTC",
      "id": 447626441,
      "name": "org335",
      "title": "org335",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2021-05-18 16:01:28 UTC",
      "updated_at": "2021-05-18 16:01:28 UTC",
      "id": 447626444,
      "name": "org336",
      "title": "org336",
      "description": null
    }
  ]
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
search optional	filter results Validations: Must be a String
order optional	Sort field and order, eg. ‘id DESC’ Validations: Must be a String
page optional	Page number, starting at 1 Validations: Must be a number.
per_page optional	Number of results per page to return, ‘all’ to return all results Validations: Must match regular expression `/\A([1-9]\d\|all)\Z$/`.

Search fields

Field name	Type	Possible values
description	text
id	integer
name	string
organization_id	integer
title	string

Examples

GET /api/organizations/447626440-org334
200
{
  "select_all_types": [],
  "description": null,
  "created_at": "2021-05-18 16:01:27 UTC",
  "updated_at": "2021-05-18 16:01:27 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626440,
  "name": "org334",
  "title": "org334",
  "users": [
    {
      "id": 980190962,
      "login": "one",
      "description": null,
      "inherited": false
    }
  ],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "environments": [],
  "hostgroups": [],
  "locations": [],
  "hosts_count": 0,
  "parameters": [
    {
      "priority": 10,
      "created_at": "2021-05-18 16:01:27 UTC",
      "updated_at": "2021-05-18 16:01:27 UTC",
      "id": 767575239,
      "name": "parameter24",
      "parameter_type": "string",
      "value": "parameter value 33"
    }
  ]
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
show_hidden_parameters optional	Display hidden parameter values Validations: Must be one of: `true`, `false`, `1`, `0`.
id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

Examples

POST /api/organizations
{
  "organization": {
    "name": "VXVwluHLhi"
  }
}
201
{
  "select_all_types": [],
  "description": null,
  "created_at": "2021-05-18 16:01:27 UTC",
  "updated_at": "2021-05-18 16:01:27 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626439,
  "name": "VXVwluHLhi",
  "title": "VXVwluHLhi",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "environments": [],
  "hostgroups": [],
  "locations": [],
  "hosts_count": 0,
  "parameters": []
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
organization required	Validations: Must be a Hash
organization[name] required	Validations: Must be a String
organization[description] optional , nil allowed	Validations: Must be a String
organization[user_ids] optional , nil allowed	User IDs Validations: Must be an array of any type
organization[smart_proxy_ids] optional , nil allowed	Smart proxy IDs Validations: Must be an array of any type
organization[compute_resource_ids] optional , nil allowed	Compute resource IDs Validations: Must be an array of any type
organization[medium_ids] optional , nil allowed	Medium IDs Validations: Must be an array of any type
organization[ptable_ids] optional , nil allowed	Partition template IDs Validations: Must be an array of any type
organization[provisioning_template_ids] optional , nil allowed	Provisioning template IDs Validations: Must be an array of any type
organization[domain_ids] optional , nil allowed	Domain IDs Validations: Must be an array of any type
organization[realm_ids] optional , nil allowed	Realm IDs Validations: Must be an array of any type
organization[hostgroup_ids] optional , nil allowed	Host group IDs Validations: Must be an array of any type
organization[environment_ids] optional , nil allowed	Environment IDs Validations: Must be an array of any type
organization[subnet_ids] optional , nil allowed	Subnet IDs Validations: Must be an array of any type
organization[parent_id] optional , nil allowed	Parent ID Validations: Must be a number.
organization[ignore_types] optional , nil allowed	List of resources types that will be automatically associated Validations: Must be an array of any type
organization[location_ids] optional , nil allowed	Associated location IDs Validations: Must be an array of any type

Examples

POST /api/organizations/114267492
{
  "organization": {
    "description": "𫾨𣫴𤤧宎𣦌䡪쭓𧗤盈𣿒𤚜熈䩕줊齇嗘𨎒閭𦂭㫽𣏖닋𠐔𢎁ᇴ冰쏿ବ𦰓𧨀莐𣕓𧋉𒅒𣽷𤽉𫁿𘟀𨭻𢟡𡥼ᣔ𒉳𬌋粐㣗𤪋𩡜𗚃𓂍损𔗘𑀰𗫳𒁝𘅛𢽪栺쎦𠱙𪥁㳥𩦡呤煐즐扮𦂆䧹𢣻𢸣𗎷𢮃𠦊𦖽샊𤏡䞏𥊿諜㣜𡡡𧑼Ɂ𠠟𤤌輻앢𗈣𒁆𡪤𗻋𠄯𣱝놂𫨲䍔𥢾𪜓𒆣𘀢𔘺즑𦈕𔕦𗟞뾾ꇶ䵱諔𣯠𡃗𠛒㹪瓚𢴄𢌌𤚾け甼驪𦰓㯺𩉨䐕𣃷𫭖㥼ಝ鉟𨀫輏𪲠𨍍Ӱ啕鐁𢸧𪒕𤙂癿蟓땞𦀹𢔯𩊽煝넇ژ蛑𫈌瞨𥨮썬𪹋𩒹𠬒𘀺𓃍착𦲶鞃𦈛𦃋𬡥뼛戕帽𨆦莴耥𑰞𢤑𦜰𠵌ᦩ𬉌纫岷𣽗𬃕𗄉𪠵𤜲䚲嬸𫽸𥬘𢼈僦𦦐𖢡䠶䖣痺㺱㶜桷𪙈酅𦸄憪𤅘𣑺ﱏ𤡧𦂔𦼘𧛻𗶑𢅺𖠐嚭떾𘤺𫤌𨠡곿䃣𘋅𨋩溄闞𧬾鴥둿𧞺鶈ᄠ𥪆颥𬙭䚁𝛮똙𒔇𩄚𬷖𒇑𩻞𞸕姵𪜹𣢡軇𑐃𨞽掱𧱟𗻗җ𗴷핑𬑙ⶽ𫩘걭棯틋ẹ欙𫆦뼉贅𠭥𠡐뻕𘤂𫛐荂鹣𩐆韍賅𩭚㽯꿷𦣥𩮠ᦞ犨𨐞ﳬ烐𩳢ᢂ띉𝙬㴢𡪈潼𥒗嵣惽𘘱𥕰𥓤𫚪𤔏𩗉詶糿𗣝ﰳ㓉걙𪌰𔖷𢅒𗤦𤨈젢ᨩ쿆ف𬓲笺꺢빢𩎠㴃𑖇𪿆ꪽ𗇨𨿗뿟𔔉𓏝吇𗒩𡧪𫳲ㅈ𦖋垎𦟍𫘜𣟹𪩤ᨇ𢞐𪓝윸𪆎𪣆𨞕ꎖঘ㡷𥠑𣒹𖥠您𩢜䀏𧷞𥥾憣𡴭䠔泯𥖃ꆪ糳朙𪕋𬕣셟𪋯ⴠ𢌮욯𦞪ꐟ𠑁ꁫ𘠉𥭠𡐑𤌕𥹹𨝚𫬞𤻛ᐣ𒍁ꆣ壶殇㾓㸨𧕒齥簀𥕻𣊢𡆑𗹦𦭿訣𢍑𩨉䝔蜔ᚓ𥚸ꑲꠀߥ𪟍𬭶𠆯𗄅遝𡪿𧣁랉Ⳝ𩓫쇕챜𫧊ﾴ븠𢎭夕𥯯𥷦䮂곇㛪ㇾꃬᣩ데𦱷㿪𩙋𐠫𢱳𧌶峗ӥ𣠭𢿹𣍖ẝ喑楧뗪𤞜𥾉뼩岿𣍟힒𫦭㛜쉶𑜄覜𤇥𫽓𩝤𨛜𬋍쥷𣐕즧𪟬𘫫덯鼣𬍇㺸𢈶𬌪𪈠벧𩘐뻎ꇵ𢸮乮𖮆𥗦𪩦𨙧𩁝脡鹽幠𗌍悢淟婩𣘄㢥凶𦯾𗛃𦺍晡뺎쟘𩯢𩲃𞸘𣗠镄𪛕𬋯我𘥹엮𫂍넥𨈌𩽊𥝀𢢅悙䜛𞹭䬬ᵈ𘙈娻𨻰𦍦鳭甽𬖎㓌粜㿃ᘑ覽洬숂뙄𤺊憛䍢봺𬬵𣽘𗴵𨼸𢐕솏眨ᶄ鎳𬭇𧸎癩𦞦胯ꡇﴀꯗ𨫪𥝭獻鳇𛱵吘滼𩉛𐳃𫩤𓅣𧴰㤙𨻂𣼯䥔찪慬𩟬𡝕𠚈偨뫪䈌𛰥ⴊ𗚂𡚄쿪낳춤𦈈ⴲ㤂ኆ稴綇꼷𑂮𨳃𧹎𤮧𨯏㧀𬙞捘筍𧔨𢝪莸𗼔𐂬堣𥘧㯊㧔ᮐ旒믲𩊈𘏖덡𡸫顉𝞬𫤧옔𤌈䇍𪀤𩕔ꯉ𩅑𫻆𣁱샗𗳶鱶椱䈳𘜙𧸌𗔇罱𧤵ⷓ𗹒𦛝ጎ獜𬒂䨛湉𤴵𛰟ᙙ煴𢶴𧴊汙𪇱𨦞覫𗰄𣱣𫑄𦟌囻𣖣㱊ﯖꞛ𨓂埞曕웸𦣏𗖭𗻃𪧻𩏲늢埂ἑ丸ㄽϒ𪦅飯𢀮𗮟퓽𪙜陳崎𧍳子𪴕꽷扴𤝭샌𦡒𩋱읳𩓍斸𣉄𢺕𠂢诋𗄾𧙉𢇼𪹴䧐𦧷𤺖𦢽덵𤚾㡽ꆰ𠓬貖𡘋𫍳𫶷𨭩𬸒𢟄𐊡笑𦻰𢼋𣋷𨇟ᾂ𔗮𩥯ࢨ𠖠𧇲𦍮𫋕𬎓긚𘘞ㄜ𥄙嫈睆輣𠡭𑐌롴왧𫡊𪻒𧪱𔐍㑎ꀦ땹𧻝𠷖𪇎𡕍𡢾룑𩴩㠔鴋𬎆륱淔ꋓ髷𥕜𪡐𣅕𠋷𡭑𝑟𫮍錽饪㢤𗰎𣻥Ⲃ邥ἳ歆𢬠捜Ӿ枱児읯𧥪熜𠘣𗾘튟𗎉어𡩩𣽅쁜𢛖ᝃ쉢ꛐ𝜗𧾛𠵤䗮珂𠤆𤹦𦒑𫄪媪겿𒃁𤊳𧰃𥝎庴갻𦥗𥌿𨨰墺剢𠺯놱𢠝瓇廭馧𪱫齭ㆂ禥黜𣓕앖ꄳ𪳂𥚒𠋋𧌠꽧𨑊螆𡬟뺺𦊷䗑胙𤛍𓎙鵀テ𥶇欥𦃖𖨣𗕲鋝㳬𢻈㫞嶑𩱅𬖷𖡾凗㦎䂈𢥶𐫣𨚨𘒗迷𗇁𘒁𧛚𫢬藹𣹈隁𩽳퉫혶慎𢡰鷘ꍝ𢭒𡀥𣖼𗈭Ḯ𪸰뎆嚶꽦𬺈𩱪ᇊ𨍻𗽆𩲑𗬱𥑋䲎𦓤𗜝䚯䡦𖩅壘鑐𐌾𣟌ۆ𩝛𫱐𥢯𬀅𒓅𪵈ሀ韋𬌙㗪㯢掼𣥾𬘯揱㛺쁈𢩌𣋨ꗷ𤌽𦤣ڟ䍞岻䈴ສ𠰑彳𥈵脪冩𪐜𡥫蔔𝓶𡄗𨉖倐돝𫎏𣹬𗤆帏𘇾觕쇡꿩𪶱𦨫𣔮𝗆𪕫𘕟𦾖淺듨𫌗𩌭𓈚䠟𣫷𥕈𤱛栣𨃰䂖𘘷𒆮𦚭𩵕𥪝𨨙퐤坺ᵕ䇲𣍢粧艾𧑇繒𞢺軗𗬭尽𢐶𢪶Ď𣜮𠅎𘣘"
  }
}
201
{
  "select_all_types": [],
  "description": "𫾨𣫴𤤧宎𣦌䡪쭓𧗤盈𣿒𤚜熈䩕줊齇嗘𨎒閭𦂭㫽𣏖닋𠐔𢎁ᇴ冰쏿ବ𦰓𧨀莐𣕓𧋉𒅒𣽷𤽉𫁿𘟀𨭻𢟡𡥼ᣔ𒉳𬌋粐㣗𤪋𩡜𗚃𓂍损𔗘𑀰𗫳𒁝𘅛𢽪栺쎦𠱙𪥁㳥𩦡呤煐즐扮𦂆䧹𢣻𢸣𗎷𢮃𠦊𦖽샊𤏡䞏𥊿諜㣜𡡡𧑼Ɂ𠠟𤤌輻앢𗈣𒁆𡪤𗻋𠄯𣱝놂𫨲䍔𥢾𪜓𒆣𘀢𔘺즑𦈕𔕦𗟞뾾ꇶ䵱諔𣯠𡃗𠛒㹪瓚𢴄𢌌𤚾け甼驪𦰓㯺𩉨䐕𣃷𫭖㥼ಝ鉟𨀫輏𪲠𨍍Ӱ啕鐁𢸧𪒕𤙂癿蟓땞𦀹𢔯𩊽煝넇ژ蛑𫈌瞨𥨮썬𪹋𩒹𠬒𘀺𓃍착𦲶鞃𦈛𦃋𬡥뼛戕帽𨆦莴耥𑰞𢤑𦜰𠵌ᦩ𬉌纫岷𣽗𬃕𗄉𪠵𤜲䚲嬸𫽸𥬘𢼈僦𦦐𖢡䠶䖣痺㺱㶜桷𪙈酅𦸄憪𤅘𣑺ﱏ𤡧𦂔𦼘𧛻𗶑𢅺𖠐嚭떾𘤺𫤌𨠡곿䃣𘋅𨋩溄闞𧬾鴥둿𧞺鶈ᄠ𥪆颥𬙭䚁𝛮똙𒔇𩄚𬷖𒇑𩻞𞸕姵𪜹𣢡軇𑐃𨞽掱𧱟𗻗җ𗴷핑𬑙ⶽ𫩘걭棯틋ẹ欙𫆦뼉贅𠭥𠡐뻕𘤂𫛐荂鹣𩐆韍賅𩭚㽯꿷𦣥𩮠ᦞ犨𨐞ﳬ烐𩳢ᢂ띉𝙬㴢𡪈潼𥒗嵣惽𘘱𥕰𥓤𫚪𤔏𩗉詶糿𗣝ﰳ㓉걙𪌰𔖷𢅒𗤦𤨈젢ᨩ쿆ف𬓲笺꺢빢𩎠㴃𑖇𪿆ꪽ𗇨𨿗뿟𔔉𓏝吇𗒩𡧪𫳲ㅈ𦖋垎𦟍𫘜𣟹𪩤ᨇ𢞐𪓝윸𪆎𪣆𨞕ꎖঘ㡷𥠑𣒹𖥠您𩢜䀏𧷞𥥾憣𡴭䠔泯𥖃ꆪ糳朙𪕋𬕣셟𪋯ⴠ𢌮욯𦞪ꐟ𠑁ꁫ𘠉𥭠𡐑𤌕𥹹𨝚𫬞𤻛ᐣ𒍁ꆣ壶殇㾓㸨𧕒齥簀𥕻𣊢𡆑𗹦𦭿訣𢍑𩨉䝔蜔ᚓ𥚸ꑲꠀߥ𪟍𬭶𠆯𗄅遝𡪿𧣁랉Ⳝ𩓫쇕챜𫧊ﾴ븠𢎭夕𥯯𥷦䮂곇㛪ㇾꃬᣩ데𦱷㿪𩙋𐠫𢱳𧌶峗ӥ𣠭𢿹𣍖ẝ喑楧뗪𤞜𥾉뼩岿𣍟힒𫦭㛜쉶𑜄覜𤇥𫽓𩝤𨛜𬋍쥷𣐕즧𪟬𘫫덯鼣𬍇㺸𢈶𬌪𪈠벧𩘐뻎ꇵ𢸮乮𖮆𥗦𪩦𨙧𩁝脡鹽幠𗌍悢淟婩𣘄㢥凶𦯾𗛃𦺍晡뺎쟘𩯢𩲃𞸘𣗠镄𪛕𬋯我𘥹엮𫂍넥𨈌𩽊𥝀𢢅悙䜛𞹭䬬ᵈ𘙈娻𨻰𦍦鳭甽𬖎㓌粜㿃ᘑ覽洬숂뙄𤺊憛䍢봺𬬵𣽘𗴵𨼸𢐕솏眨ᶄ鎳𬭇𧸎癩𦞦胯ꡇﴀꯗ𨫪𥝭獻鳇𛱵吘滼𩉛𐳃𫩤𓅣𧴰㤙𨻂𣼯䥔찪慬𩟬𡝕𠚈偨뫪䈌𛰥ⴊ𗚂𡚄쿪낳춤𦈈ⴲ㤂ኆ稴綇꼷𑂮𨳃𧹎𤮧𨯏㧀𬙞捘筍𧔨𢝪莸𗼔𐂬堣𥘧㯊㧔ᮐ旒믲𩊈𘏖덡𡸫顉𝞬𫤧옔𤌈䇍𪀤𩕔ꯉ𩅑𫻆𣁱샗𗳶鱶椱䈳𘜙𧸌𗔇罱𧤵ⷓ𗹒𦛝ጎ獜𬒂䨛湉𤴵𛰟ᙙ煴𢶴𧴊汙𪇱𨦞覫𗰄𣱣𫑄𦟌囻𣖣㱊ﯖꞛ𨓂埞曕웸𦣏𗖭𗻃𪧻𩏲늢埂ἑ丸ㄽϒ𪦅飯𢀮𗮟퓽𪙜陳崎𧍳子𪴕꽷扴𤝭샌𦡒𩋱읳𩓍斸𣉄𢺕𠂢诋𗄾𧙉𢇼𪹴䧐𦧷𤺖𦢽덵𤚾㡽ꆰ𠓬貖𡘋𫍳𫶷𨭩𬸒𢟄𐊡笑𦻰𢼋𣋷𨇟ᾂ𔗮𩥯ࢨ𠖠𧇲𦍮𫋕𬎓긚𘘞ㄜ𥄙嫈睆輣𠡭𑐌롴왧𫡊𪻒𧪱𔐍㑎ꀦ땹𧻝𠷖𪇎𡕍𡢾룑𩴩㠔鴋𬎆륱淔ꋓ髷𥕜𪡐𣅕𠋷𡭑𝑟𫮍錽饪㢤𗰎𣻥Ⲃ邥ἳ歆𢬠捜Ӿ枱児읯𧥪熜𠘣𗾘튟𗎉어𡩩𣽅쁜𢛖ᝃ쉢ꛐ𝜗𧾛𠵤䗮珂𠤆𤹦𦒑𫄪媪겿𒃁𤊳𧰃𥝎庴갻𦥗𥌿𨨰墺剢𠺯놱𢠝瓇廭馧𪱫齭ㆂ禥黜𣓕앖ꄳ𪳂𥚒𠋋𧌠꽧𨑊螆𡬟뺺𦊷䗑胙𤛍𓎙鵀テ𥶇欥𦃖𖨣𗕲鋝㳬𢻈㫞嶑𩱅𬖷𖡾凗㦎䂈𢥶𐫣𨚨𘒗迷𗇁𘒁𧛚𫢬藹𣹈隁𩽳퉫혶慎𢡰鷘ꍝ𢭒𡀥𣖼𗈭Ḯ𪸰뎆嚶꽦𬺈𩱪ᇊ𨍻𗽆𩲑𗬱𥑋䲎𦓤𗜝䚯䡦𖩅壘鑐𐌾𣟌ۆ𩝛𫱐𥢯𬀅𒓅𪵈ሀ韋𬌙㗪㯢掼𣥾𬘯揱㛺쁈𢩌𣋨ꗷ𤌽𦤣ڟ䍞岻䈴ສ𠰑彳𥈵脪冩𪐜𡥫蔔𝓶𡄗𨉖倐돝𫎏𣹬𗤆帏𘇾觕쇡꿩𪶱𦨫𣔮𝗆𪕫𘕟𦾖淺듨𫌗𩌭𓈚䠟𣫷𥕈𤱛栣𨃰䂖𘘷𒆮𦚭𩵕𥪝𨨙퐤坺ᵕ䇲𣍢粧艾𧑇繒𞢺軗𗬭尽𢐶𢪶Ď𣜮𠅎𘣘",
  "created_at": "2021-05-18 16:01:25 UTC",
  "updated_at": "2021-05-18 16:01:27 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 114267492,
  "name": "Empty Organization",
  "title": "Empty Organization",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "environments": [],
  "hostgroups": [],
  "locations": [],
  "hosts_count": 0,
  "parameters": []
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
organization required	Validations: Must be a Hash
organization[name] optional	Validations: Must be a String
organization[description] optional , nil allowed	Validations: Must be a String
organization[user_ids] optional , nil allowed	User IDs Validations: Must be an array of any type
organization[smart_proxy_ids] optional , nil allowed	Smart proxy IDs Validations: Must be an array of any type
organization[compute_resource_ids] optional , nil allowed	Compute resource IDs Validations: Must be an array of any type
organization[medium_ids] optional , nil allowed	Medium IDs Validations: Must be an array of any type
organization[ptable_ids] optional , nil allowed	Partition template IDs Validations: Must be an array of any type
organization[provisioning_template_ids] optional , nil allowed	Provisioning template IDs Validations: Must be an array of any type
organization[domain_ids] optional , nil allowed	Domain IDs Validations: Must be an array of any type
organization[realm_ids] optional , nil allowed	Realm IDs Validations: Must be an array of any type
organization[hostgroup_ids] optional , nil allowed	Host group IDs Validations: Must be an array of any type
organization[environment_ids] optional , nil allowed	Environment IDs Validations: Must be an array of any type
organization[subnet_ids] optional , nil allowed	Subnet IDs Validations: Must be an array of any type
organization[parent_id] optional , nil allowed	Parent ID Validations: Must be a number.
organization[ignore_types] optional , nil allowed	List of resources types that will be automatically associated Validations: Must be an array of any type
organization[location_ids] optional , nil allowed	Associated location IDs Validations: Must be an array of any type
id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

Params

Param name

Description

location_id
optional

Set the current location context for the request

Validations:

Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

Must be a Integer

id
required

Validations:

Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

Organizations

GET /api/organizations
List all organizations

Examples

Params

Search fields

GET /api/organizations/:id
Show an organization

Examples

Params

POST /api/organizations
Create an organization

Examples

Params

PUT /api/organizations/:id
Update an organization

Examples

Params

DELETE /api/organizations/:id
Delete an organization

Params

Organizations

GET /api/organizations List all organizations

Examples

Params

Search fields

GET /api/organizations/:id Show an organization

Examples

Params

POST /api/organizations Create an organization

Examples

Params

PUT /api/organizations/:id Update an organization

Examples

Params

DELETE /api/organizations/:id Delete an organization

Params

GET /api/organizations
List all organizations

GET /api/organizations/:id
Show an organization

POST /api/organizations
Create an organization

PUT /api/organizations/:id
Update an organization

DELETE /api/organizations/:id
Delete an organization