# Get block.

Get block.

Endpoint: GET /blocks/{block_id}
Version: 1.0.0
Security: Token

## Path parameters:

  - `block_id` (string, required)
    The ID of a block. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

## Response 200 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "success"

  - `data` (object)
    A calendar block.

  - `data.id` (string, required)
    The ID of the calendar event.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `data.type` (string, required)
    The type of the calendar event.
    Enum: "APPOINTMENT", "CALENDAR_BLOCK", "EXTERNAL", "BUFFER", "DECLINED_APPOINTMENT", "UNSCHEDULED_APPOINTMENT"

  - `data.title` (string, required)
    The title of the calendar event.
    Example: "Other appointment"

  - `data.description` (string,null, required)
    The description of the calendar event.
    Example: "sdjsudsudsds"

  - `data.start_at` (string, required)
    The start time of the calendar event (ISO 8601 format).
    Example: "2020-10-04T12:15:00Z"

  - `data.end_at` (string, required)
    The end time of the calendar event (ISO 8601 format).
    Example: "2020-10-04T12:30:00Z"

  - `data.is_all_day` (boolean, required)
    Is the calendar event all day?
    Example: true

  - `data.duration` (integer, required)
    The duration of the calendar event in minutes.
    Example: 60

  - `data.is_busy` (boolean, required)
    Is the calendar event busy?
    Example: true

  - `data.users` (array)

  - `data.users.object` (string,null)
    A canonical value representing a resource.
    Example: "PERSONAL_ACCESS_TOKEN"

  - `data.users.id` (string, required)
    ID of the entity. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

  - `data.users.email` (string, required)
    Email address of the user.
    Example: "john.doe@gmail.com"

  - `data.users.first_name` (string,null)
    First name of the user.
    Example: "John"

  - `data.users.last_name` (string,null)
    Last name of the user.
    Example: "Doe"

  - `data.users.full_name` (string,null)
    The full name of the user.
    Example: "John Doe"

  - `data.users.internal_notes` (string,null)
    Internal notes for the user.
    Example: "Internal notes for the user."

  - `data.users.status` (string)
    The status of the user.
    Enum: "active", "inactive", "new", "sso"

  - `data.users.phone` (string,null)
    A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens).
    Example: "123456789"

  - `data.users.avatar_url` (string,null)
    The avatar image URL of a user.
    Example: "https://picsum.photos/300"

  - `data.users.relationship` (string,null)
    Describes user's relationship (access level) to a specified group. Only returned if this resource is returned as a sub-resource of a group.
    Example: "owner"

  - `data.users.sso_users` (array)
    The list of SSO users associated with this user.

  - `data.users.sso_users.sso_id` (string, required)
    SSO ID of the user
    Example: "1234"

  - `data.users.sso_users.sso_provider` (object)
    A SSO Provider contains the information pertaining to the SSO connection.

  - `data.users.sso_users.sso_provider.name` (string, required)
    Name of the provider
    Example: "Some Company"

  - `data.users.sso_users.sso_provider.provider` (string, required)
    Technology of the provider
    Example: "Auth0"

  - `data.users.is_super` (boolean,null)
    Indicates if the user is a super user.
    Example: true

  - `data.users.verification_status` (string)
    The verification status of the user.
    Enum: "verified", "unverified", "new", "sso"

  - `data.users.password_expiration_days` (integer,null)
    The number of days until the user's password expires.
    Example: 30

  - `data.users.timezone` (string,null)
    The default timezone for the user.
    Example: "America/New_York"

  - `data.users.created_at` (string,null)
    The date and time (ISO 8601 format) when the user was created.
    Example: "2021-06-30T20:30:00Z"

  - `data.company_team_members` (array)

  - `data.company_team_members.calendar_color` (string,null)
    Color code for calendar display, if assigned
    Example: "#FF0000"

  - `data.company_team_members.permissions` (array, required)
    List of permissions granted to the team member

  - `data.company_team_members.permissions.name` (string, required)
    The name of the permission
    Enum: "ACTIVITY_LOG_VIEW", "APP_STORE_VIEW_ANY", "APPOINTMENTS_MANAGE", "AVAILABILITY_VIEW_ANY", "CALENDAR_VIEW_ANY", "CUSTOMER_CREATE", "CUSTOMER_DELETE", "CUSTOMER_EXPORT_CREATE", "CUSTOMER_IMPORT_CREATE", "CUSTOMER_VIEW_ANY", "FEE_VIEW_ANY", "LISTING_CREATE", "LISTING_DELETE", "LISTING_VIEW_ANY", "MEDIA_REQUEST_MANAGE", "ORDER_AMOUNT_VIEW_ANY", "ORDER_FORM_VIEW_ANY", "ORDER_NOTES_MANAGE", "ORDER_VIEW_ANY", "ORDERS_MANAGE", "PAYMENT_METHODS_MANAGE", "PAYROLL_MANAGE", "PAYROLL_PERSONAL_MANAGE", "PAYROLL_PERSONAL_VIEW", "PRODUCT_VIEW_ANY", "REPORT_VIEW_ANY", "SETTINGS_MANAGE", "TAX_VIEW_ANY", "TERRITORY_VIEW_ANY", "ZILLOW_MEDIA_EXCLUSIVES_MANAGE"

  - `data.company_team_members.restrictions` (array, required)
    List of restrictions applied to the team member

  - `data.company_team_members.is_service_provider` (boolean, required)
    Indicates if the team member is a service provider
    Example: true

  - `data.company_team_members.external_id` (string,null)
    External identifier for the team member, if any
    Example: "1234567890"

  - `data.company_team_members.company_user` (object,null)
    A record of a person on the Aryeo platform.

  - `data.company_team_members.has_owner_role` (boolean,null)
    Indicates if the team member has the owner role
    Example: true

  - `data.company_team_members.is_owner` (boolean,null)
    Indicates if the team member is the owner
    Example: true

  - `data.company_team_members.invitation_accepted_at` (string,null)
    The date and time (ISO 8601 format) when the company team member invitation was accepted
    Example: "2025-04-01T05:59:59.999999Z"

  - `data.company_team_members.role` (string,null)
    The role of the team member
    Enum: "ADMIN", "MEMBER", "OWNER"

  - `data.company_team_members.status` (string,null)
    The status of the team member
    Enum: "active", "invited", "revoked"

  - `data.company_team_members.is_active` (boolean,null)
    Indicates if the team member is active
    Example: true

  - `data.company_team_members.is_invited` (boolean,null)
    Indicates if the team member is invited
    Example: true

  - `data.company_team_members.is_revoked` (boolean,null)
    Indicates if the team member is revoked
    Example: true

  - `data.company_team_members.scheduling_priority` (integer,null)
    The scheduling priority of the team member
    Example: 1

  - `data.company_team_members.created_at` (string,null)
    The date and time (ISO 8601 format) when the company team member was created
    Example: "2025-04-01T05:59:59.999999Z"

  - `data.company_team_members.require_appointment_confirmation` (boolean,null)
    Indicates if the team member requires appointment confirmation
    Example: true

  - `timestamp` (string,null)
    The request timestamp (ISO 8601).
    Example: "2021-06-30T20:30:00Z"

## Response 404 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 404

## Response 422 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "fail"

## Response 500 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 500