Difference between revisions of "Meeting Types(API)"

From SimplyMeet.me
Line 19: Line 19:
 
|-
 
|-
 
| colspan="3" style="color:gray; border-bottom: 2px solid gray" |Query Parameters
 
| colspan="3" style="color:gray; border-bottom: 2px solid gray" |Query Parameters
|- style="line-height:1;"
+
|-  
 
| sorting<br><span style="font-size:10px; color:gray;">OPTIONAL</span>
 
| sorting<br><span style="font-size:10px; color:gray;">OPTIONAL</span>
 
| <code>object</code>
 
| <code>object</code>
 
+
| Sorting parameters, e.g. sorting[created_at]=desc
 
+
|-  
| <span style="vertical-align: middle;">Sorting parameters, e.g. sorting[created_at]=desc</span>
 
 
 
 
 
|- style="line-height:1;"
 
 
| limit<br><span style="font-size:10px; color:gray;">OPTIONAL</span>
 
| limit<br><span style="font-size:10px; color:gray;">OPTIONAL</span>
 
| <code>string</code>
 
| <code>string</code>
 
+
| A limit on the number of objects to be returned. The default is 10.
 
+
|-  
| <span style="vertical-align: middle;">A limit on the number of objects to be returned. The default is 10.</span>
 
 
 
 
 
|- style="line-height:1;"
 
 
| page<br><span style="font-size:10px; color:gray;">OPTIONAL</span>
 
| page<br><span style="font-size:10px; color:gray;">OPTIONAL</span>
 
| <code>number</code>
 
| <code>number</code>
 
+
| Page number. The default is 1.
 
 
| <span style="vertical-align: middle;">Page number. The default is 1.</span>
 
 
|}
 
|}
  

Revision as of 09:58, 20 August 2021

GET List all user meeting types

https://harmonizely.com/api/users/me/meeting-types

Returns a list of user meeting types. The meeting types are returned in sorted order, with the most recent meeting types appearing first.


Request

Headers
X-API-KEY
REQUIRED
string Your API key


Query Parameters
sorting
OPTIONAL
object Sorting parameters, e.g. sorting[created_at]=desc
limit
OPTIONAL
string A limit on the number of objects to be returned. The default is 10.
page
OPTIONAL
number Page number. The default is 1.


Response
200: OK
A dictionary with a _embedded property that contains items property that contains an array of up to limit meeting types.

{  
   "page":1,
   "limit":10,
   "pages":1,
   "total":1,
   "_embedded":{
      "items":[
         {
            "name":"15 min meeting",
            "description":"15 min meeting description",
            "duration":15,
            "slug":"15min",
            "uuid":"7ab22519-0135-2941-0bd6-a3381d173110"
         }
      ]
   },
   "_links":{
      "self":{
         "href":"/api/users/me/meeting-types?page=1&limit=10"
      },
      "first":{
         "href":"/api/users/me/meeting-types?page=1&limit=10"
      },
      "last":{
         "href":"/api/users/me/meeting-types?page=1&limit=10"
      }
   }
}


Examples
curl -H "X-API-KEY: <your_api_key>" https://harmonizely.com/api/users/me/meeting-types