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 also belongs to an activity type categories.

By default, each account comes with a set of predefined activity types, like Went to a restaurant or Went to the theater.

List all the activity types in your account

GET /activitytypes/

Parameters

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

Response

{
    "data": [
        {
            "id": 1,
            "object": "activityType",
            "name": "společný čas",
            "location_type": null,
            "activity_type_category": {
                "id": 1,
                "object": "activityTypeCategory",
                "name": "Simple activities",
                "account": {
                    "id": 1
                },
                "created_at": null,
                "updated_at": null
            },
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 2,
            "object": "activityType",
            "name": "sledování filmu doma",
            "location_type": null,
            "activity_type_category": {
                "id": 1,
                "object": "activityTypeCategory",
                "name": "Simple activities",
                "account": {
                    "id": 1
                },
                "created_at": null,
                "updated_at": null
            },
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 3,
            "object": "activityType",
            "name": "promluvili jsme si doma",
            "location_type": null,
            "activity_type_category": {
                "id": 1,
                "object": "activityTypeCategory",
                "name": "Simple activities",
                "account": {
                    "id": 1
                },
                "created_at": null,
                "updated_at": null
            },
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 4,
            "object": "activityType",
            "name": "společný sport",
            "location_type": null,
            "activity_type_category": {
                "id": 2,
                "object": "activityTypeCategory",
                "name": "Sport",
                "account": {
                    "id": 1
                },
                "created_at": null,
                "updated_at": null
            },
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 5,
            "object": "activityType",
            "name": "ate at their place",
            "location_type": null,
            "activity_type_category": {
                "id": 3,
                "object": "activityTypeCategory",
                "name": "Food",
                "account": {
                    "id": 1
                },
                "created_at": null,
                "updated_at": null
            },
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 6,
            "object": "activityType",
            "name": "návštěva baru",
            "location_type": null,
            "activity_type_category": {
                "id": 3,
                "object": "activityTypeCategory",
                "name": "Food",
                "account": {
                    "id": 1
                },
                "created_at": null,
                "updated_at": null
            },
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 7,
            "object": "activityType",
            "name": "jídlo doma",
            "location_type": null,
            "activity_type_category": {
                "id": 3,
                "object": "activityTypeCategory",
                "name": "Food",
                "account": {
                    "id": 1
                },
                "created_at": null,
                "updated_at": null
            },
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 8,
            "object": "activityType",
            "name": "piknik",
            "location_type": null,
            "activity_type_category": {
                "id": 3,
                "object": "activityTypeCategory",
                "name": "Food",
                "account": {
                    "id": 1
                },
                "created_at": null,
                "updated_at": null
            },
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 9,
            "object": "activityType",
            "name": "jídlo v restauraci",
            "location_type": null,
            "activity_type_category": {
                "id": 3,
                "object": "activityTypeCategory",
                "name": "Food",
                "account": {
                    "id": 1
                },
                "created_at": null,
                "updated_at": null
            },
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 10,
            "object": "activityType",
            "name": "návštěva divadla",
            "location_type": null,
            "activity_type_category": {
                "id": 4,
                "object": "activityTypeCategory",
                "name": "Cultural activities",
                "account": {
                    "id": 1
                },
                "created_at": null,
                "updated_at": null
            },
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 11,
            "object": "activityType",
            "name": "návštěva koncertu",
            "location_type": null,
            "activity_type_category": {
                "id": 4,
                "object": "activityTypeCategory",
                "name": "Cultural activities",
                "account": {
                    "id": 1
                },
                "created_at": null,
                "updated_at": null
            },
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 12,
            "object": "activityType",
            "name": "návštěva zápasu",
            "location_type": null,
            "activity_type_category": {
                "id": 4,
                "object": "activityTypeCategory",
                "name": "Cultural activities",
                "account": {
                    "id": 1
                },
                "created_at": null,
                "updated_at": null
            },
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        {
            "id": 13,
            "object": "activityType",
            "name": "návštěva muzea",
            "location_type": null,
            "activity_type_category": {
                "id": 4,
                "object": "activityTypeCategory",
                "name": "Cultural activities",
                "account": {
                    "id": 1
                },
                "created_at": null,
                "updated_at": null
            },
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        }
    ],
    "links": {
        "first": "http:\/\/monica.test\/api\/activitytypes?page=1",
        "last": "http:\/\/monica.test\/api\/activitytypes?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http:\/\/monica.test\/api\/activitytypes",
        "per_page": 15,
        "to": 13,
        "total": 13
    }
}

Get a specific activity type

GET /activitytypes/:id

Response

{
    "data": {
        "id": 1,
        "object": "activityType",
        "name": "společný čas",
        "location_type": null,
        "activity_type_category": {
            "id": 1,
            "object": "activityTypeCategory",
            "name": "Simple activities",
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        "account": {
            "id": 1
        },
        "created_at": null,
        "updated_at": null
    }
}

Create an activity type

POST /activitytypes/

Input

Name Type Description
name string Required. The name of the activity type. Max 255 characters.
activity_type_category_id integer Required. The ID of the type of activity type category that the activity type is associated with.

Example

{
    "name":"this is a name",
    "activity_type_category_id":1
}

Response

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

{
    "data": {
        "id": 27,
        "object": "activityType",
        "name": "this is a name",
        "location_type": null,
        "activity_type_category": {
            "id": 1,
            "object": "activityTypeCategory",
            "name": "Simple activities",
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        "account": {
            "id": 1
        },
        "created_at": "2018-07-13T16:16:16Z",
        "updated_at": "2018-07-13T16:16:16Z"
    }
}

Update an activity type

PUT /activitytypes/:id

Input

Name Type Description
name string Required. The name of the activity type. Max 255 characters.
activity_type_category_id integer Required. The ID of the type of activity type category that the activity type is associated with.

Example

{
    "name":"For my friend Leslie Knope",
    "activity_type_category_id":1
}

Response

{
    "data": {
        "id": 27,
        "object": "activityType",
        "name": "For my friend Leslie Knope",
        "location_type": null,
        "activity_type_category": {
            "id": 1,
            "object": "activityTypeCategory",
            "name": "Simple activities",
            "account": {
                "id": 1
            },
            "created_at": null,
            "updated_at": null
        },
        "account": {
            "id": 1
        },
        "created_at": "2018-07-13T16:16:16Z",
        "updated_at": "2018-07-13T16:16:57Z"
    }
}

Delete an activity type

DELETE /activitytypes/:id

Response

The response sends back the id that was just deleted.

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

Company

Resources

© 2018

Proudly Canadian