---
title: "AppointmentTypes.get"
method: GET
path: "/entities/AppointmentTypes/{id}"
tags: ["Activity"]
---

# AppointmentTypes.get

`GET /entities/AppointmentTypes/{id}`

Returns AppointmentType with given id

## Path parameters

- `id` string, uuid, required

## Response `200`

AppointmentType data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` AppointmentType
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `form_edit` object — JSON definition of the form layout used by the UI when creating or editing appointments of this type.
    - `icon` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 — Icon used to display appointments of this type in the UI. Integer enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem
    - `is_readonly` boolean, required — True when the appointment type is system-managed and cannot be edited or deleted by users.
    - `name` string, required — Name of the entity and its default text representation.
    - `is_published` boolean — True when the entity configuration is published; false while it exists only as an unpublished draft.
    - `revision` integer — Revision when entity was lastly changed.
    - `has_draft` boolean, required — Set to True if draft for entity exists and can be published
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `form_edit_api` object, required — API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts.
    - `can_change_readonly` boolean — Returns if user can change readonly flag on this entity_type.

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.dev/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.dev/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/revisions/e8c12ae60aca/schema)