Show All Activities

GET

GET

https://api.atzcrm.com/v1/activity

Retrieve a paginated, filterable list of all activities in your account.

Request

GET

GET /v1/activity

Query Parameters

• pageinteger

  Page number. Default: 1

• limitinteger

  Number of records per page. Max: 25. Default: 25

• sort_bystring

  Field to sort by. Allowed values: created_at, updated_at. Default: updated_at

• sort_orderstring

  Sort direction. One of: asc, desc. Default: desc

• importancestring

  Filter by importance level. One of: low, normal, high, critical

• activity_type_idinteger

  Filter by activity type. Inbuilt: 2 (Meeting), 3 (Task), 4 (Email), 5 (Interview). To fetch all available types for your account, use the Get Activity Types endpoint.

• related_to_entityinteger

  Filter by entity type: 1 (Candidate), 2 (Job), 3 (Organization), 4 (Contact), 5 (Deal), 10 (Other)

• related_tostring

  Filter by the slug of a related record. Example: candidate_abc123

• searchstring

  Search across title, description, and location fields.

• maximizestring

  Comma-separated list of fields to expand in the response. Allowed values:

  • created_by
  • updated_by
  • related_record
  • all

  Example: GET /v1/activity?maximize=created_by,related_record

Headers

• Authorization: Bearer your_access_token

Response

200

Body

• totalnumber

  Total number of matching records.

• per_pagenumber

  Number of records per page.

• current_pagenumber

  Current page number.

• last_pagenumber

  Total number of pages.

• next_page_urlstring or null

  URL of the next page, or null if on the last page.

• prev_page_urlstring or null

  URL of the previous page, or null if on the first page.

• fromnumber

  Index of the first record on this page.

• tonumber

  Index of the last record on this page.

• dataarray

  Array of activity objects. See Add Activity response for the full activity schema.

400

Body

• Invalid sort_order or sort_by value

401

Body

• Unauthorized

Response Example

{
    "total": 2,
    "per_page": 25,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "from": 1,
    "to": 2,
    "data": [
        {
            "id": 42,
            "title": "Team Sync",
            "activity_type": { "id": 2, "label": "Meeting" },
            "related_to": "candidate_abc123",
            "related_record": { "slug": "candidate_abc123" },
            "related_to_type": "candidate",
            "collaborators": [],
            "start_date": "2024-06-15",
            "start_time": "10:00",
            "end_time": "11:00",
            "attendees": {
                "candidates": [],
                "contacts": [],
                "users": []
            },
            "meeting_link": "https://meet.google.com/abc-xyz",
            "importance": "high",
            "location": "Conference Room A",
            "description": "Monthly team sync",
            "do_not_send_calendar_invite": false,
            "mark_as_done": false,
            "attachment": null,
            "created_by": { "id": 1, "slug": "user_abc", "full_name": "John Doe", "email": "john@example.com" },
            "updated_by": { "id": 1, "slug": "user_abc", "full_name": "John Doe", "email": "john@example.com" },
            "created_at": "2024-06-15T10:00:00Z",
            "updated_at": "2024-06-15T10:00:00Z"
        },
        {
            "id": 43,
            "title": "Candidate Interview",
            "activity_type": { "id": 5, "label": "Interview" },
            "related_to": "cand_xyz",
            "related_record": { "slug": "cand_xyz" },
            "related_to_type": "candidate",
            "collaborators": [],
            "start_date": "2024-06-16",
            "start_time": "14:00",
            "end_time": "15:00",
            "attendees": {
                "candidates": [{ "slug": "cand_xyz", "full_name": "Jane Smith" }],
                "contacts": [],
                "users": []
            },
            "meeting_link": "",
            "importance": "critical",
            "location": "Main Office",
            "description": "Technical round",
            "do_not_send_calendar_invite": false,
            "mark_as_done": false,
            "attachment": null,
            "created_by": { "id": 1, "slug": "user_abc", "full_name": "John Doe", "email": "john@example.com" },
            "updated_by": { "id": 1, "slug": "user_abc", "full_name": "John Doe", "email": "john@example.com" },
            "created_at": "2024-06-14T09:00:00Z",
            "updated_at": "2024-06-14T09:00:00Z"
        }
    ]
}