API documentation

Activities

Overview

When adding an activity done with a contact, you can associate it with a type of activity. This is useful to categorize your activities done with your contacts.

An activity type belongs to an activity type categories.

By default, each account comes with a set of predefined activity type categories.

List all the activity type categories in your account

GET /activitytypecategories/

Parameters

Name Type Description
limit integer Indicates the page size.
page integer Indicates the page to return.

Response

{
    "data": [
        {
            "id": 1,
            "object": "activityTypeCategory",
            "name": "Simple activities",
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 2,
            "object": "activityTypeCategory",
            "name": "Sport",
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 3,
            "object": "activityTypeCategory",
            "name": "Food",
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 4,
            "object": "activityTypeCategory",
            "name": "Cultural activities",
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        }
    ],
    "links": {
        "first": "http:\/\/monica.test\/api\/activitytypecategories?page=1",
        "last": "http:\/\/monica.test\/api\/activitytypecategories?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http:\/\/monica.test\/api\/activitytypecategories",
        "per_page": 15,
        "to": 4,
        "total": 4
    }
}

Get a specific activity type category

GET /activitytypecategories/:id

Response

{
    "data": {
        "id": 1,
        "object": "activityTypeCategory",
        "name": "Simple activities",
        "account": {
            "id": 1
        },
        "created_at": null,
        "updated_at": null
    }
}

Create an activity type category

POST /activitytypecategories/

Input

Name Type Description
name string Required. The name of the activity type. Max 255 characters.

Example

{
    "name":"this is a name"
}

Response

The API call returns an Activity type category object if the call succeeds.

{
    "data": {
        "id": 9,
        "object": "activityTypeCategory",
        "name": "This is a name",
        "account": {
            "id": 1
        },
        "created_at": "2018-07-13T16:30:37Z",
        "updated_at": "2018-07-13T16:30:37Z"
    }
}

Update an activity type category

PUT /activitytypecategories/:id

Input

Name Type Description
name string Required. The name of the activity type. Max 255 characters.

Example

{
    "name":"For my friend Leslie Knope"
}

Response

{
    "data": {
        "id": 9,
        "object": "activityTypeCategory",
        "name": "This is a name",
        "account": {
            "id": 1
        },
        "created_at": "2018-07-13T16:30:37Z",
        "updated_at": "2018-07-13T16:30:37Z"
    }
}

Delete an activity type category

DELETE /activitytypecategories/:id

Response

The response sends back the id that was just deleted.

{
  "deleted": true,
  "id": 31
}

Company

Resources

© 2018

Proudly Canadian