List Notes and Call Logs
GET https://api.chartmogul.com/v1/customer_notes
Returns a list of all note objects for your whole account or a specific customer.
curl -X GET "https://api.chartmogul.com/v1/customer_notes?per_page=20&cursor=aabbcc..." \ -u YOUR_API_KEY: \ChartMogul::Note.all( per_page: 20, cursor: "aabbcc...", )ChartMogul.CustomerNote.all(config, { per_page: 20, cursor: "aabbccdd...", });ChartMogul\CustomerNote::all([ "cursor" => "aabbccdd...", "per_page" => "20" ])api.ListNote(&cm.ListNoteParams{})chartmogul.CustomerNote.all( config, cursor="aabbcc...", per_page=20, ){ "entries": [ { "uuid": "note_39351ba6-dea0-11ee-ac96-37b2b3de29af", "customer_uuid": "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0", "type": "note", "text": "They are a world leader in specialized software.\nThey are in SaaS business.", "call_duration": 0, "author": "Sara ([email protected])", "created_at": "2023-11-01T00:00:00.000Z", "updated_at": "2023-12-21T10:53:50.082Z" } // ...and more ], "cursor": "aabbcc...", "has_more": true }#<ChartMogul::Notes:0x00007f82834c9368 @entries=[ #<ChartMogul::Note:0x00007f82834c9188 @uuid="note_39351ba6-dea0-11ee-ac96-37b2b3de29af", @customer_uuid="cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0", @type="note", @text="They are a world leader in specialized software.\nThey are in SaaS business.", @author="Sara ([email protected])", @call_duration=0, @created_at="2023-11-01T00:00:00.000Z", @updated_at="2023-12-21T10:53:50.082Z">, # ...and more > ], @has_more=true, @cursor="aabbcc..." >{ entries: [ { uuid: "note_39351ba6-dea0-11ee-ac96-37b2b3de29af", customer_uuid: "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0", type: "note", text: "They are a world leader in specialized software.\nThey are in SaaS business.", call_duration: 0, author: "Sara ([email protected])", created_at: "2023-11-01T00:00:00.000Z", updated_at: "2023-12-21T10:53:50.082Z" } // ...and more ], cursor: "aabbcc...", has_more: true }class ChartMogul\Resource\CollectionWithCursor (3) { public $has_more => bool(true) public $cursor => string(96) "aabbcc..." private $elements => array(20) { [0] => class ChartMogul\CustomerNote () { protected $uuid => string(41) "note_39351ba6-dea0-11ee-ac96-37b2b3de29af" protected $customer_uuid => string(40) "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0" protected $type => string(4) "note" protected $text => string(49) "They are a world leader in specialized software.\n" protected $call_duration => int(1) protected $author => string(23) "Adam ([email protected])" protected $created_at => string(24) "2023-11-01T00:00:00.000Z" protected $updated_at => string(24) "2023-12-21T10:53:50.082Z" }, // ...and more } }(*chartmogul.Notes)(0x14000206900)({ Entries: ([]*chartmogul.Note) (len=1 cap=4){ (*chartmogul.Note)(0x17000568000)({ UUID: (string) (len=41) "note_39351ba6-dea0-11ee-ac96-37b2b3de29af", CustomerUUID: (string) (len=40) "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0", Type: (string) (len=40) "note", Text: (string) (len=49) "They are a world leader in specialized software.\n", CallDuration (uint32) 0 Author: (string) (len=23) "[email protected]", CreatedAt: (string) (len=24) "2023-11-01T00:00:00.000Z", UpdatedAt: (string) (len=24) "2023-12-21T10:53:50.082Z" }), // ...and more }, Cursor: (string) (len=7) "aabbcc...", HasMore: (bool) true })Notes( entries=[<Note{ uuid: "note_39351ba6-dea0-11ee-ac96-37b2b3de29af", customer_uuid: "cus_52eb54c2-dea0-11ed-ac96-ef735d89fca0", type: "note", text: "They are a world leader in specialized software.\nThey are in SaaS business.", call_duration: 0, author: "Sara ([email protected])", created_at: "2023-11-01T00:00:00.000Z", updated_at: "2023-12-21T10:53:50.082Z" }>, // ...and more ] has_more=True, cursor="aabbcc..." )Query parameters
customer_uuidstring optional- The UUID of the customer to whom the notes belongs.
typestring optional- The type of customer note. Can be either
noteorcall. author_emailstring optional- The email of the author of the note or call. The email has to match a user that belongs to the account.
cursorstring optional- A value that fetches the next page of notes. To fetch the next page of notes, set the cursor to the value received in the previous page response.
per_pageint32 optional default: 200- A limit on the number of notes to return per page. The default and maximum value is 200.
Response
In the response, the JSON object contains the following data:
entries- The list of note objects.
cursor- The reference to the next list of notes.
has_more- Determines whether there are more notes to query after this particular request. Returns true if there are, and false if there aren’t.