Activity Types

API Endpoints for Activity Types

List Activity Types get

https://crm.example.com/api/activity-typesTest Endpoint

Headers Required headers

Content-TypeRequiredstringapplication/json
AcceptRequiredstringapplication/json
AuthorizationRequiredstringBearer {token}

Query Parameters

orderOptionalstring Sort the results being queried.
Example: ?order=created_at or ?order=created_at|desc
selectOptionalstring Select only the provided fields, useful for query optimization.
Example: ?select=first_name;id
per_pageOptionalinteger Provide the total number of records to query per page.
Example: ?per_page=20
pageOptionalinteger The page number to retrieve results for.
Example: ?page=2
qOptionalstring Search records by a given query.
Example: ?q=John
search_fieldsOptionalstring Change the fields that the search will be performed to
Example:?search_fields=email:like;phones.number:=
search_matchOptionalstring 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 Type get

https://crm.example.com/api/activity-types/{id}Test Endpoint

Headers Required headers

Content-TypeRequiredstringapplication/json
AcceptRequiredstringapplication/json
AuthorizationRequiredstringBearer {token}

Path Parameters

idRequiredintegerThe ID of the record

Create Activity Type post

https://crm.example.com/api/activity-typesTest Endpoint

Headers Required headers

Content-TypeRequiredstringapplication/json
AcceptRequiredstringapplication/json
AuthorizationRequiredstringBearer {token}

Body Parameters

nameRequiredstring
iconRequiredstring
swatch_colorOptionalstringActivity type color in HEX format

Update Activity Type put

https://crm.example.com/api/activity-types/{id}Test Endpoint

Headers Required headers

Content-TypeRequiredstringapplication/json
AcceptRequiredstringapplication/json
AuthorizationRequiredstringBearer {token}

Path Parameters

idRequiredintegerThe ID of the record

Body Parameters

nameRequiredstring
iconRequiredstring
swatch_colorOptionalstringActivity type color in HEX format

Delete Activity Type delete

https://crm.example.com/api/activity-types/{id}Test Endpoint

Headers Required headers

Content-TypeRequiredstringapplication/json
AcceptRequiredstringapplication/json
AuthorizationRequiredstringBearer {token}

Path Parameters

idRequiredintegerThe ID of the record

Search Activity Types get

https://crm.example.com/api/activity-types/search?q={query}Test Endpoint
Use this endpoint to perform search without pagination and use the take parameter if you need to limit the results.

Headers Required headers

Content-TypeRequiredstringapplication/json
AcceptRequiredstringapplication/json
AuthorizationRequiredstringBearer {token}

Path Parameters

qRequiredstring

Query Parameters

takeOptionalinteger The maximum number of results to query
Example: ?take=1
orderOptionalstring Sort the results being queried.
Example: ?order=created_at or ?order=created_at|desc
selectOptionalstring Select only the provided fields, useful for query optimization.
Example: ?select=first_name;id
search_fieldsOptionalstring Change the fields that the search will be performed to
Example:?search_fields=email:like;phones.number:=
search_matchOptionalstring 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