--- title: "Get activity" method: GET path: "/crm/activities/{id}" tags: ["Activities"] --- # Get activity `GET /crm/activities/{id}` Get activity ## Path parameters - `id` string, required ## Query parameters - `raw` boolean - `fields` string, nullable ## Headers - `x-apideck-consumer-id` string, required - `x-apideck-app-id` string, required - `x-apideck-service-id` string ## Response `200` Activity - GetActivityResponse - `status_code` integer, required — HTTP Response Status Code - `status` string, required — HTTP Response Status - `service` string, required — Apideck ID of service provider - `resource` string, required — Unified API resource name - `operation` string, required — Operation performed - `data` Activity, required - `id` string — The unique identifier of the activity - `downstream_id` string, nullable — The third-party API ID of original entity - `activity_datetime` string, nullable — The date and time of the activity - `duration_seconds` integer, nullable — The duration of the activity in seconds - `user_id` string, nullable — The user related to the activity - `account_id` string, nullable — The account related to the activity - `contact_id` string, nullable — The contact related to the activity - `company_id` string, nullable — The company related to the activity - `opportunity_id` string, nullable — The opportunity related to the activity - `lead_id` string, nullable — The lead related to the activity - `owner_id` string, nullable — The owner of the activity - `campaign_id` string, nullable — The campaign related to the activity - `case_id` string, nullable — The case related to the activity - `asset_id` string, nullable — The asset related to the activity - `contract_id` string, nullable — The contract related to the activity - `product_id` string, nullable — The product related to the activity - `solution_id` string, nullable — The solution related to the activity - `custom_object_id` string, nullable — The custom object related to the activity - `type` 'call' | 'meeting' | 'email' | 'note' | 'task' | 'deadline' | 'send-letter' | 'send-quote' | 'other', nullable, required — The type of the activity - `title` string, nullable — The title of the activity - `description` string, nullable — A description of the activity - `note` string, nullable — An internal note about the activity - `location` string, nullable — The location of the activity - `location_address` Address - `id` string, nullable — Unique identifier for the address. - `type` 'primary' | 'secondary' | 'home' | 'office' | 'shipping' | 'billing' | 'work' | 'other', nullable — The type of address. - `string` string, nullable — The address string. Some APIs don't provide structured address data. - `name` string, nullable — The name of the address. - `line1` string, nullable — Line 1 of the address e.g. number, street, suite, apt #, etc. - `line2` string, nullable — Line 2 of the address - `line3` string, nullable — Line 3 of the address - `line4` string, nullable — Line 4 of the address - `line5` string, nullable — Line 5 of the address - `street_number` string, nullable — Street number - `city` string, nullable — Name of city. - `state` string, nullable — Name of state - `postal_code` string, nullable — Zip code or equivalent. - `country` string, nullable — country code according to ISO 3166-1 alpha-2. - `latitude` string, nullable — Latitude of the address - `longitude` string, nullable — Longitude of the address - `county` string, nullable — Address field that holds a sublocality, such as a county - `contact_name` string, nullable — Name of the contact person at the address - `salutation` string, nullable — Salutation of the contact person at the address - `phone_number` string, nullable — Phone number of the address - `fax` string, nullable — Fax number of the address - `email` string, nullable — Email address of the address - `website` string, nullable — Website of the address - `notes` string, nullable — Additional notes - `row_version` string, nullable — A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. - `all_day_event` boolean, nullable — Whether the Activity is an all day event or not - `private` boolean, nullable — Whether the Activity is private or not - `group_event` boolean, nullable — Whether the Activity is a group event or not - `event_sub_type` string, nullable — The sub type of the group event - `group_event_type` string, nullable — The type of the group event - `child` boolean, nullable — Whether the activity is a child of another activity or not - `archived` boolean, nullable — Whether the activity is archived or not - `deleted` boolean, nullable — Whether the activity is deleted or not - `show_as` 'free' | 'busy', nullable - `done` boolean, nullable — Whether the Activity is done or not - `start_datetime` string, nullable — The start date and time of the activity - `end_datetime` string, nullable — The end date and time of the activity - `duration_minutes` integer, nullable — The duration of the activity in minutes - `activity_date` string, nullable — The date of the activity - `end_date` string, nullable — The end date of the activity - `recurrent` boolean — Whether the activity is recurrent or not - `reminder_datetime` string, nullable — The date and time of the reminder - `reminder_set` boolean, nullable — Whether the reminder is set or not - `video_conference_url` string, nullable — The URL of the video conference - `video_conference_id` string, nullable — The ID of the video conference - `custom_fields` CustomField[] — Custom fields of the activity - union - object - `id` string, nullable, required — Unique identifier for the custom field. - `name` string, nullable — Name of the custom field. - `description` string, nullable — More information about the custom field - `value` union - string, nullable - number, nullable - boolean, nullable - object, nullable - union[] - … - object - `id` string, nullable — Unique identifier for the custom field. - `name` string, nullable, required — Name of the custom field. - `description` string, nullable — More information about the custom field - `value` union - string, nullable - number, nullable - boolean, nullable - object, nullable - union[] - … - `attendees` ActivityAttendee[] - `id` string, nullable — Unique identifier for the attendee - `name` string, nullable — Full name of the attendee - `first_name` string, nullable — First name of the attendee - `middle_name` string, nullable — Middle name of the attendee - `last_name` string, nullable — Last name of the attendee - `prefix` string, nullable — Prefix of the attendee - `suffix` string, nullable — Suffix of the attendee - `email_address` string, nullable — Email address of the attendee - `is_organizer` boolean, nullable — Whether the attendee is the organizer of the activity - `status` 'accepted' | 'tentative' | 'declined', nullable — Status of the attendee - `user_id` string, nullable — The identifier for a related user - `contact_id` string, nullable — The identifier for a related contact - `updated_at` string, date-time, nullable — The last time the attendee was updated (ISO 8601) - `created_at` string, date-time, nullable — The time the attendee was created (ISO 8601) - `custom_mappings` CustomMappings, nullable — When custom mappings are configured on the resource, the result is included here. - `updated_by` string, nullable — The user who last updated the activity - `created_by` string, nullable — The user who created the activity - `updated_at` string, nullable — The date and time when the activity was last updated - `created_at` string, nullable — The date and time when the activity was created - `pass_through` object[] — The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. - `service_id` string, required — Identifier for the service to which this pass_through should be applied. - `operation_id` string — Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request. - `extend_object` object — Simple object allowing any properties for direct extension. - `extend_paths` object[] — Array of objects for structured data modifications via paths. - `path` string, required — JSONPath string specifying where to apply the value. - `value` unknown, required - `meta` Meta — Response metadata - `items_on_page` integer — Number of items returned in the data property of the response - `cursors` object — Cursors to navigate to previous or next pages through the API - `previous` string, nullable — Cursor to navigate to the previous page of results through the API - `current` string, nullable — Cursor to navigate to the current page of results through the API - `next` string, nullable — Cursor to navigate to the next page of results through the API - `total_count` integer — Number of records available in total for this resource - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200. - `type` string — Discriminator for the warning kind. - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available. - `error` string, nullable — Short error description from the downstream provider, when available. - `operation` string, nullable — Identifier of the workflow step that failed. - `message` string, nullable — Detailed message from the downstream provider, when available. - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided ## Other responses - `400` — Bad Request - `401` — Unauthorized - `402` — Payment Required - `404` — The specified resource was not found - `422` — Unprocessable - `default` — Unexpected error --- [API](https://skmtc.net/apideck-libraries/apis/crm-api.md) · [All operations](https://skmtc.net/apideck-libraries/apis/crm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apideck-libraries/crm-api/versions/171537af6722/schema)