---
title: "GET /app-instance-users/{appInstanceUserArn}/endpoints/{endpointId}"
method: GET
path: "/app-instance-users/{appInstanceUserArn}/endpoints/{endpointId}"
---

# GET /app-instance-users/{appInstanceUserArn}/endpoints/{endpointId}

`GET /app-instance-users/{appInstanceUserArn}/endpoints/{endpointId}`

Returns the full details of an <code>AppInstanceUserEndpoint</code>.

## Path parameters

- `appInstanceUserArn` string, required
- `endpointId` string, required

## Response `200`

Success

- DescribeAppInstanceUserEndpointResponse
  - `AppInstanceUserEndpoint` object — The full details of an <code>AppInstanceUserEndpoint</code>: the <code>AppInstanceUserArn</code>, ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.
    - `AppInstanceUserArn` string — The ARN of the <code>AppInstanceUser</code>.
    - `EndpointId` string — The unique identifier of the <code>AppInstanceUserEndpoint</code>.
    - `Name` string, password — The name of the <code>AppInstanceUserEndpoint</code>.
    - `Type` 'APNS' | 'APNS_SANDBOX' | 'GCM' — The type of the <code>AppInstanceUserEndpoint</code>.
    - `ResourceArn` string — The ARN of the resource to which the endpoint belongs.
    - `EndpointAttributes` object — The attributes of an <code>Endpoint</code>.
      - `DeviceToken` string, password, required — The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
      - `VoipDeviceToken` string, password — The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
    - `CreatedTimestamp` string, date-time — The time at which an <code>AppInstanceUserEndpoint</code> was created.
    - `LastUpdatedTimestamp` string, date-time — The time at which an <code>AppInstanceUserEndpoint</code> was last updated.
    - `AllowMessages` 'ALL' | 'NONE' — Boolean that controls whether the <code>AppInstanceUserEndpoint</code> is opted in to receive messages. <code>ALL</code> indicates the endpoint will receive all messages. <code>NONE</code> indicates the endpoint will receive no messages.
    - `EndpointState` object — <p>A read-only field that represents the state of an <code>AppInstanceUserEndpoint</code>. Supported values:</p> <ul> <li> <p> <code>ACTIVE</code>: The <code>AppInstanceUserEndpoint</code> is active and able to receive messages. When <code>ACTIVE</code>, the <code>EndpointStatusReason</code> remains empty.</p> </li> <li> <p> <code>INACTIVE</code>: The <code>AppInstanceUserEndpoint</code> is inactive and can't receive message. When <code>INACTIVE</code>, the corresponding reason will be conveyed through <code>EndpointStatusReason</code>.</p> </li> <li> <p> <code>INVALID_DEVICE_TOKEN</code> indicates that an <code>AppInstanceUserEndpoint</code> is <code>INACTIVE</code> due to invalid device token</p> </li> <li> <p> <code>INVALID_PINPOINT_ARN</code> indicates that an <code>AppInstanceUserEndpoint</code> is <code>INACTIVE</code> due to an invalid pinpoint ARN that was input through the <code>ResourceArn</code> field.</p> </li> </ul>
      - `Status` 'ACTIVE' | 'INACTIVE', required — Enum that indicates the Status of an <code>AppInstanceUserEndpoint</code>.
      - `StatusReason` 'INVALID_DEVICE_TOKEN' | 'INVALID_PINPOINT_ARN' — The reason for the <code>EndpointStatus</code>.

## Other responses

- `480` — BadRequestException
- `481` — ForbiddenException
- `482` — ThrottledClientException
- `483` — UnauthorizedClientException
- `484` — ServiceUnavailableException
- `485` — ServiceFailureException

---

[API](https://skmtc.net/aws/apis/chime-sdk-identity.md) · [All operations](https://skmtc.net/aws/apis/chime-sdk-identity/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/chime-sdk-identity/versions/5ac0320cd9af/schema)