🖇️Activities
API Endpoints for Activities
List Activities GET
Endpoint: https://subdomain.appcrm.com.br/api/activities
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 Activity GET
Endpoint: https://subdomain.appcrm.com.br/api/activities/{id}
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 Activity POST
Endpoint: https://subdomain.appcrm.com.br/api/activities
Headers
Content-Type
Required
string
application/json
Accept
Required
string
application/json
Authorization
Required
string
Bearer {token}
Body Parameters
title
string
activity_type_id
Optional
integer
ID of the activity type If not provided, the default selected activity type in Settings -> Activities will be used.
user_id
Required
integer
The owner/assigned of the activity
note
Optional
string
description
Optional
string
due_date
Required
date
Activity due date in UTC format Example: Only date: 2021-05-04 With time: 2021-05-04 10:00:00
end_date
Optional
date
Activity end date in UTC format Example: Only date: 2021-05-05 With time: 2021-05-05 10:00:00 When creating activity, if not provided, the activity due date will be used as end date.
reminder_minutes_before
Optional
integer
Minutes to send reminder before the due date
guests
Optional
array
Example:
[
"users" => [2, 3],
"contacts" => [4, 5],
]is_completed
Optional
boolean
contacts
Optional
array
Array of contact ID's the activity is associated with.
companies
Optional
array
Array of company ID's the activity is associated with.
deals
Optional
array
Array of deal ID's the activity is associated with.
Update Activity PUT
Endpoint: https://subdomain.appcrm.com.br/api/activities/{id}
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
title
Required
string
user_id
Optional
integer
The owner/assigned of the activity
note
Optional
string
description
Optional
string
due_date
Optional
date
Activity due date in UTC format Example: Only date: 2021-05-04 With time: 2021-05-04 10:00:00
end_date
Optional
date
Activity end date in UTC format Example: Only date: 2021-05-05 With time: 2021-05-05 10:00:00
reminder_minutes_before
Optional
integer
Minutes to send reminder before the due date
guests
Optional
array
Example:
[
"users" => [2, 3],
"contacts" => [4, 5],
]is_completed
Optional
boolean
contacts
Optional
array
Array of contact ID's the activity is associated with.
companies
Optional
array
Array of company ID's the activity is associated with.
deals
Optional
array
Array of deal ID's the activity is associated with.
Delete Activity DELETE
Endpoint: https://subdomain.appcrm.com.br/api/activities/{id}
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 Activity GET
Endpoint: https://subdomian.appcrm.com.br/api/activities/search?q={query}
Use this endpoint to perform search without pagination and use the take parameter if you need to limit the results.
Hearders
Content-Type
Required
string
application/json
Accept
Required
string
application/json
Authorization
Required
string
Bearer {token}
Path
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
Attach Associations to Activity PUT
Endpoint: https://subdomian.appcrm.com.br/api/associations/activities/{id}
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
Make sure to provide at least one resource.
Body Parameters
contacts
Optional
array
Array of contacts ID's to attach
companies
Optional
array
Array of companies ID's to attach
deals
Optional
array
Array of deals ID's to attach
Detach Associations From Activity DELETE
Endpoint: https://subdomain.appcrm.com.br/api/associations/activities/{id}
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
Make sure to provide at least one resource.
Body Parameters
contacts
Optional
array
Array of contacts ID's to detach
companies
Optional
array
Array of companies ID's to detach
deals
Optional
array
Array of deals ID's to detach
Sync Associations To Activity POST
Endpoint: https://subdomain.appcrm.com.br/api/associations/activities/{id}
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
Make sure to provide at least one resource.
Body Parameters
contacts
Optional
array
Array of contacts ID's to sync
companies
Optional
array
Array of companies ID's to sync
deals
Optional
array
Array of deals ID's to sync
Change Activity Status POST
Endpoint: https://subdomain.appcrm.com.br/api/activities/{id}/{status}
This endpoint is deprecated, use the activity update endpoint and provide the is_completed attribute.
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
status
Required
string
Any of ['complete', 'incomplete']
Last updated
Was this helpful?