Notes

API Endpoints for Notes

List Notes get

https://relatecrm.example.com/api/notes

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Query Parameters
order (Optional) string Sort the results being queried.
Example: ?order=created_at or ?order=created_at\|desc
select (Optional) string Select only the provided fields, useful for query optimization.
Example: ?select=first_name;id
per_page (Optional) integer Provide the total number of records to query per page.
Example: ?per_page=20
page (Optional) integer The page number to retrieve results for.
Example: ?page=2
q (Optional) string Search records by a given query.
Example: ?q=John
search_fields (Optional) string Change the fields that the search will be performed to
Example:?search_fields=email:like;phones.number:=
search_match (Optional) string By default the search queries are performed using the OR comparison operator for each query parameter, if you need to match all parameters, you will need to use the AND comparison operator.
Example: ?search_match=and

Retrieve Note get

https://relatecrm.example.com/api/notes/{id}

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Path Parameters
id (Required) integer The ID of the record

Create Note post

https://relatecrm.example.com/api/notes

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Body Parameters
body (Required) string
via_resource (Required) string Any of ['contacts', 'companies', 'deals']
via_resource_id (Required) integer
task_date (Optional) date Create follow up activity of type task with the given date in UTC format
At this time, associating notes to multiple resources is available only via API, however, it's recommend to associate the record only to one resource as you won't be able to update them via the dashboard.
contacts (Optional) array
companies (Optional) array
deals (Optional) array

Update Note put

https://relatecrm.example.com/api/notes/{id}

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Path Parameters
id (Required) integer The ID of the record

Body Parameters
body (Required) string
via_resource (Required) string Any of ['contacts', 'companies', 'deals']
via_resource_id (Required) integer
At this time, associating notes to multiple resources is available only via API, however, it's recommend to associate the record only to one resource as you won't be able to update them via the dashboard.
contacts (Optional) array
companies (Optional) array
deals (Optional) array

Delete Note delete

https://relatecrm.example.com/api/notes/{id}

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Path Parameters
id (Required) integer The ID of the record

Search Notes get

https://relatecrm.example.com/api/notes/search?q={query}

Use this endpoint to perform search without pagination and use the take parameter if you need to limit the results.

Headers Required headers
Content-Type (Required) string application/json
Accept (Required) string application/json
Authorization (Required) string Bearer {token}

Path Parameters
q (Required) string

Query Parameters
take (Optional) integer The maximum number of results to query
Example: ?take=1
order (Optional) string Sort the results being queried.
Example: ?order=created_at or ?order=created_at\|desc
select (Optional) string Select only the provided fields, useful for query optimization.
Example: ?select=first_name;id
search_fields (Optional) string Change the fields that the search will be performed to
Example:?search_fields=email:like;phones.number:=
search_match (Optional) string By default the search queries are performed using the OR comparison operator for each query parameter, if you need to match all parameters, you will need to use the AND comparison operator.
Example: ?search_match=and