{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/groups","auth":"required","method":"get","params":[{"name":"app_id","type":"string","default":"","desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","required":true,"in":"path","ref":"","_id":"57ff8232e7218a1900673d08"},{"name":"resource_type","type":"string","default":"","desc":"Group resource_type, can be one of: [campaigns, segments, beacons, geofences]","required":false,"in":"query","ref":"","_id":"5874f65b967ae00f00164851"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"hidden\": false,\n    \"hidden_at\": null,\n    \"name\": \"groupXX\",\n    \"resource_type\": \"Mobile::App::Campaign\",\n    \"resource_ids\": [\n      \"58591aec636f6e9a51c00300\",\n      \"58591acc636f6e9a51ae0300\",\n      \"58591a9e636f6e9a51a80300\",\n      \"58591a6d636f6e9a51a50300\",\n      \"5873927a636f6ef6a9ab0000\",\n      \"58739219636f6ef6a9a80000\"\n    ],\n    \"id\": \"587384b3636f6ea5f5110000\"\n  }\n]","name":""}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"name":"","code":"curl -X GET \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/groups\"\n\t-H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\"","language":"shell"}]}},"next":{"description":"","pages":[]},"title":"Groups: Get All (Index)","type":"endpoint","slug":"groups-get-all","excerpt":"","body":"","updates":[],"order":45,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e4fced159815700262d28ff","createdAt":"2017-01-10T14:56:38.167Z","parentDoc":null,"user":"5874dcd9edcf9f2f00f9e0af","category":{"sync":{"isSync":false,"url":""},"pages":["5e4fced159815700262d28c6","5e4fced159815700262d28c7","5e4fced159815700262d28c8","5e4fced159815700262d28c9","5e4fced159815700262d28ca","5e4fced159815700262d28cb","5e4fced159815700262d28cc","5e4fced159815700262d28cd","5e4fced159815700262d28ce","564c68a93eb8f81700838a25"],"title":"Pulsate CMS API","slug":"pulsate-cms-api","order":1,"from_sync":false,"reference":true,"_id":"5e4fced159815700262d289e","__v":10,"createdAt":"2015-11-17T23:47:10.058Z","project":"54aa7f773b56130b0056c86e","version":"5e4fced159815700262d2930"},"project":"54aa7f773b56130b0056c86e","__v":3,"githubsync":"","version":{"version":"2.2","version_clean":"2.2.0","codename":"CMS API","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e4fced159815700262d2899","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","5e4fced159815700262d289a","5e4fced159815700262d289b","5e4fced159815700262d289c","5e4fced159815700262d289d","5e4fced159815700262d289e","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","5e4fced159815700262d289f","5e4fced159815700262d28a0","5c73dd27e8fdc000572a206a","5e4fced159815700262d28a1","5e53c04c1d11110018b56e12"],"_id":"5e4fced159815700262d2930","project":"54aa7f773b56130b0056c86e","forked_from":"55781fe25129590d003ff4f7","__v":1,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z"}}

getGroups: Get All (Index)


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string
App ID. It can be fetched by using "Apps: Get All (Index)" or "Apps: Get One (Show)" endpoints.

Query Params

resource_type:
string
Group resource_type, can be one of: [campaigns, segments, beacons, geofences]

Examples


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 }}