Difference between revisions of "Meeting Types(API)"
From SimplyMeet.me
| (14 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ||
<span style="background-color:#3158e2; color:white; padding:5px; border-radius:15px;">GET</span> '''List all user meeting types''' | <span style="background-color:#3158e2; color:white; padding:5px; border-radius:15px;">GET</span> '''List all user meeting types''' | ||
| − | <pre>https:// | + | <pre>https://secure.simplymeet.me/api/users/me/meeting-types</pre> |
Returns a list of user meeting types. The meeting types are returned in sorted order, with the most recent meeting types appearing first. | Returns a list of user meeting types. The meeting types are returned in sorted order, with the most recent meeting types appearing first. | ||
| − | + | '''Request''' | |
| − | {| class="table" style="width:100%; border: 2px solid black; border- | + | {| class="table" style="width:100%; border: 2px solid black;" |
| − | | X-API-KEY | + | |- |
| − | + | | colspan="3" style="color:gray; border-bottom: 2px solid gray" |Headers | |
| − | + | |- | |
| + | | X-API-KEY<br><span style="font-size:10px; color:red;">REQUIRED</span> | ||
| + | | <code>string</code> | ||
| + | | Your API key | ||
|} | |} | ||
| − | {| class="table" style="width:100%; border: 2px solid black | + | <br> |
| − | + | {| class="table" style="width:100%; border: 2px solid black;" | |
|- | |- | ||
| − | | sorting | + | | colspan="3" style="color:gray; border-bottom: 2px solid gray" |Query Parameters |
| − | | object | + | |- |
| + | | sorting<br><span style="font-size:10px; color:gray;">OPTIONAL</span> | ||
| + | | <code>object</code> | ||
| Sorting parameters, e.g. sorting[created_at]=desc | | Sorting parameters, e.g. sorting[created_at]=desc | ||
| − | |- | + | |- |
| − | | limit | + | | limit<br><span style="font-size:10px; color:gray;">OPTIONAL</span> |
| − | | string | + | | <code>string</code> |
| A limit on the number of objects to be returned. The default is 10. | | A limit on the number of objects to be returned. The default is 10. | ||
| + | |- | ||
| + | | page<br><span style="font-size:10px; color:gray;">OPTIONAL</span> | ||
| + | | <code>number</code> | ||
| + | | Page number. The default is 1. | ||
|} | |} | ||
| − | + | '''Response'''<br> | |
| − | < | + | <span style="width: 10px; |
| − | A dictionary with a _embedded property that contains items property that contains an array of up to limit meeting types. | + | height: 10px; |
| − | { | + | display: inline-block; |
| + | font-size: 16px; | ||
| + | font-family: Content-font, Roboto, sans-serif; | ||
| + | font-weight: 400; | ||
| + | line-height: 1.625; | ||
| + | margin-right: 6px; | ||
| + | border-radius: 50%; | ||
| + | background-color: rgb(38, 203, 124);"></span>200: OK<br> | ||
| + | A dictionary with a <code>_embedded</code> property that contains <code>items</code> property that contains an array of up to <code>limit</code> meeting types. | ||
| + | <pre> | ||
| + | { | ||
"page":1, | "page":1, | ||
"limit":10, | "limit":10, | ||
| Line 55: | Line 74: | ||
} | } | ||
} | } | ||
| − | } | + | }</pre> |
| − | </pre> | + | <br> |
| − | < | + | '''Examples'''<br> |
| − | curl -H "X-API-KEY: <your_api_key>" https:// | + | <pre> |
| − | + | curl -H "X-API-KEY: <your_api_key>" https://secure.simplymeet.me/api/users/me/meeting-types</pre> | |
Latest revision as of 12:57, 24 March 2022
GET List all user meeting types
https://secure.simplymeet.me/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://secure.simplymeet.me/api/users/me/meeting-types
