{"_id":"56d04587376b040b005b2f7d","parentDoc":null,"project":"55e58b63d101191900f30b13","user":"5554788cb450630d00041dbc","version":{"_id":"55e58b63d101191900f30b16","__v":3,"project":"55e58b63d101191900f30b13","createdAt":"2015-09-01T11:26:27.668Z","releaseDate":"2015-09-01T11:26:27.668Z","categories":["55e58b65d101191900f30b17","55e58d16f493c11700584314","55e58d1bd101191900f30b1d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","__v":5,"category":{"_id":"55e58d1bd101191900f30b1d","version":"55e58b63d101191900f30b16","__v":13,"pages":["55e58d27191aa90d0052b52f","55e58d56191aa90d0052b531","55e58d6ff493c11700584315","55e58d81f493c11700584318","55e59b9bd101191900f30b75","55e59c1ff11ba80d003238f1","55e7325f2d0d3021000db050","55e732ca58e25f35001437a6","55e7339e2d0d3021000db052","55e734aa7991b92100b209ed","55f7028ba7ceef0d00251c19","56669144ce8caf0d006018b6","56d04587376b040b005b2f7d"],"project":"55e58b63d101191900f30b13","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-01T11:33:47.501Z","from_sync":false,"order":2,"slug":"rest-api","title":"REST API"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-26T12:31:03.484Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"{\n    \"status\": \"success\",\n    \"segment_list\": [\n        {\n            \"id\": \"15\",\n            \"name\": \"adwords\"\n        },\n        {\n            \"id\": \"157\",\n            \"name\": \"global\"\n        },\n        {\n            \"id\": \"199\",\n            \"name\": \"homepage\"\n        }\n    ]\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[],"url":"/segments"},"isReference":false,"order":11,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Description\"\n}\n[/block]\nStatus: To denote whether the request succeeded or not. Values can be 'success' or 'failure'.\n\nSegment List: List of segments with their name and IDs","excerpt":"This endpoint is used to get a list of segment names with their unique Segment IDs. The request method of this call needs to be \"GET\".\n\nThe same Segment ID is used to identify the segment while sending notifications to that segment and adding/removing subscribers to/from the segment.","slug":"get-list-of-segments","type":"endpoint","title":"Get List of Segments"}

getGet List of Segments

This endpoint is used to get a list of segment names with their unique Segment IDs. The request method of this call needs to be "GET". The same Segment ID is used to identify the segment while sending notifications to that segment and adding/removing subscribers to/from the segment.

Definition

{{ api_url }}{{ page_api_url }}

Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Response Description" } [/block] Status: To denote whether the request succeeded or not. Values can be 'success' or 'failure'. Segment List: List of segments with their name and IDs