GET :version/notes
Returns a list of note objects by created date
A request requires a date range that can be supplied by using created_date_from
and created_date_to
.
Query parameters
Name | Description | Values | Required |
---|---|---|---|
created_date_from | Notes that were created on and after this date | ISO datetime | True |
created_date_to | Notes that were created before this date | ISO datetime | True |
page_size | Number of results to return | integer | False |
Notes created between 14:00 8th of March to midnight 8th of March
"https://ca-eu.conversocial.com/api/1/notes?created_date_from=2016-03-08T10:00:00&created_date_to=2016-03-08&page_size=1"
{
"notes": [
{
"action": "add_note",
"author": {
"author_ids": [
"t:2825986021"
],
"customer_profiles_id": "564b5d829bd56c14074805f0"
},
"created_date": "2016-03-15T17:48:49.988000",
"id": "56e84b019bd56c6a6c692a5a",
"text": "Oh god damn diamonds all in my fronts",
"user": 16
}
],
"paging": {
"next_page": null
}
}
Notes created on the 1st of March
"https://ca-eu.conversocial.com/api/1/notes?created_date_from=2016-03-01&created_date_to=2016-03-01"
Notes created on the 1st of March, returning only 10 results
"https://ca-eu.conversocial.com/api/1/notes?created_date_from=2016-03-01&created_date_to=2016-03-01&page_size=10"
Examples
# python
import requests
base_url = "https://ca-eu.conversocial.com/api"
response = requests.get(
"https://ca-eu.conversocial.com/api/1/notes?created_date_from=2016-03-01T14:00:00&created_date_to=2016-03-01T18:00:00",
auth=("iamausername", "iamapassword"))
print response.status_code
> 200
# bash
curl -u "iamapassword:iamausername"
"https://ca-eu.conversocial.com/api/1/notes?created_date_from=2016-03-01T14:00:00&created_date_to=2016-03-01T18:00:00"