{"__v":2,"_id":"551233b80c1a08190077f97a","category":{"__v":17,"_id":"54e431e7de9f5b2300fc6dbe","pages":["54e431e7de9f5b2300fc6dc0","54e56a19c2f66835000133be","54f646a1542ade0d00f1c686","54f675a4b175300d00d44b9f","54f675f31ad1c41900a4815f","54f67f4cd53b280d00b6c4a8","54ffd33c564faf2f008e123d","551233b80c1a08190077f97a","551234a9f9ece423005b244c","552728a2e69c7d0d00047eb0","5527296e975eef3700ca805c","55272a19d7ea1c2300e58aa3","55272a8d7d4a4417009516f8","55272ac0d7ea1c2300e58aa4","552744574a7ac121004c60f6","552744d3975eef3700ca8075","55596943dab6630d00792641"],"project":"545a65231d018b1400227d8f","version":"54e431e6de9f5b2300fc6dbc","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-11-05T17:59:19.427Z","from_sync":false,"order":4,"slug":"event-api","title":"EVENT API"},"editedParams":true,"editedParams2":true,"project":"545a65231d018b1400227d8f","user":"545a64cfbf1d2b0e00aaa091","version":{"__v":10,"_id":"54e431e6de9f5b2300fc6dbc","forked_from":"545a65231d018b1400227d92","project":"545a65231d018b1400227d8f","createdAt":"2015-02-18T06:32:06.531Z","releaseDate":"2015-02-18T06:32:06.531Z","categories":["54e431e7de9f5b2300fc6dbd","54e431e7de9f5b2300fc6dbe","54e56a85c2f66835000133c3","54ff948548c94d23004f1e17","5527280be69c7d0d00047eaf","55273bb14a7ac121004c60f0","55274588975eef3700ca8077","552748df9d4bcd2300d0383d","55274dd79d4bcd2300d0384a","55fa03180e1f1f1700a1f6ce","55fa3172d6f4370d001d99fd"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-03-25T04:04:08.611Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n\"Status\": \"ok\",\n  \"Result\": [\n      {\n      \"ID\": 3535,\n      \"Name\": \"A grand event\",\n      \"Description\": \"This is just a test event.\",\n      \"PresentedBy\": \"\",\n      \"NotAvailableMessage\": \"\",\n      \"ThanksMessage\": \"\",\n      \"EmailMessage\": \"\",\n      \"FooterText\": \"\",\n      \"Notification\": false,\n      \"ShowDetails\": false,\n      \"ShowComments\": false,\n      \"ShowSocialMedia\": false,\n      \"ShowDeadline\": false,\n      \"AttachTicket\": false,\n      \"Deadline\": \"2015-11-07T23:00:00Z\",\n      \"Start\": \"2015-11-10T23:00:00Z\",\n      \"Stop\": \"2015-11-10T23:00:00Z\",\n      \"ActiveStart\": \"2000-01-01T01:00:00Z\",\n      \"Terms\": \"\",\n      \"PushURL\": \"\",\n      \"Subdomain\": \"reg\",\n      \"ReturnURL\": \"\",\n      \"Hashtag\": \"\",\n      \"Currency\": \"\",\n      \"AdwordsTrackingCode\": \"\",\n      \"Password\": \"\",\n      \"TimezoneName\": \"Australia/Melbourne\",\n      \"UserID\": 3,\n      \"GroupID\": 3,\n      \"GroupName\": \"Some events\",\n      \"Status\": \"active\",\n      \"Available\": true,\n      \"TimeTillStart\": \"5 months from now\",\n      \"TimeTillDeadline\": \"5 months from now\",\n      \"EditDeadline\": \"2014-01-01T00:00:00Z\",\n      \"EditUserDetails\": false,\n      \"URL\": \"https://test.canbook.me/testevent\"\n      },\n      {\n      \"ID\": 3535,\n      \"Name\": \"A grand event\",\n      \"Description\": \"This is just a test event.\",\n      \"PresentedBy\": \"\",\n      \"NotAvailableMessage\": \"\",\n      \"ThanksMessage\": \"\",\n      \"EmailMessage\": \"\",\n      \"FooterText\": \"\",\n      \"Notification\": false,\n      \"ShowDetails\": false,\n      \"ShowComments\": false,\n      \"ShowSocialMedia\": false,\n      \"ShowDeadline\": false,\n      \"AttachTicket\": false,\n      \"Deadline\": \"2015-11-07T23:00:00Z\",\n      \"Start\": \"2015-11-10T23:00:00Z\",\n      \"Stop\": \"2015-11-10T23:00:00Z\",\n      \"ActiveStart\": \"2000-01-01T01:00:00Z\",\n      \"Terms\": \"\",\n      \"PushURL\": \"\",\n      \"Subdomain\": \"reg\",\n      \"ReturnURL\": \"\",\n      \"Hashtag\": \"\",\n      \"Currency\": \"\",\n      \"AdwordsTrackingCode\": \"\",\n      \"Password\": \"\",\n      \"TimezoneName\": \"Australia/Melbourne\",\n      \"UserID\": 3,\n      \"GroupID\": 3,\n      \"GroupName\": \"Some events\",\n      \"Status\": \"active\",\n      \"Available\": true,\n      \"TimeTillStart\": \"5 months from now\",\n      \"TimeTillDeadline\": \"5 months from now\",\n      \"EditDeadline\": \"2014-01-01T00:00:00Z\",\n      \"EditUserDetails\": false,\n      \"URL\": \"https://test.canbook.me/testevent2\"\n      }\n    ]\n}","language":"json","status":200},{"name":"","code":"{\n  \"Status\": \"error\",\n  \"Errors\": [\n    {\n      \"Key\": \"eventId\",\n      \"Message\": \"The Event id is not valid\"\n    }\n  ]\n}","language":"json","status":400}]},"auth":"required","params":[{"_id":"551233b80c1a08190077f97b","ref":"","in":"query","required":false,"desc":"Select one of \"active\", \"available\", \"group\" or leave blank for all events","default":"active","type":"string","name":"ListType"},{"_id":"55272791d7ea1c2300e58aa1","ref":"","in":"query","required":false,"desc":"If you select \"group\" for the listType, set the listTypeId as the group id you want to get the events for","default":"","type":"int","name":"ListTypeId"}],"url":"/event/:list_type/:list_type_id"},"isReference":false,"order":3,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"The various event list types:\",\n  \"body\": \"/event\\n/event/active\\n/event/available\\n/event/group/123\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Library examples\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl \\\\\\n  -H \\\"Content-Type: application/json\\\" \\\\\\n  -u \\\"testuser:moy1zZCscHpx7ei8CzNA\\\" \\\\\\n  https://api.attendly.net/v2/event/available\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"Get a list of your events. You can get all your events, only your events marked as active or your events that are active and available now.","slug":"event-list","type":"get","title":"Event list"}

getEvent list

Get a list of your events. You can get all your events, only your events marked as active or your events that are active and available now.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

ListType:
stringactive
Select one of "active", "available", "group" or leave blank for all events
ListTypeId:
integer
If you select "group" for the listType, set the listTypeId as the group id you want to get the events for

Result Format


Documentation

[block:callout] { "type": "info", "title": "The various event list types:", "body": "/event\n/event/active\n/event/available\n/event/group/123" } [/block] [block:api-header] { "type": "basic", "title": "Library examples" } [/block] [block:code] { "codes": [ { "code": "curl \\\n -H \"Content-Type: application/json\" \\\n -u \"testuser:moy1zZCscHpx7ei8CzNA\" \\\n https://api.attendly.net/v2/event/available", "language": "curl" } ] } [/block]