Function getConversationAttachments

getConversationAttachments<ThrowOnError extends boolean = true>(
    options: Options<GetConversationAttachmentsData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes?: {
                contentLength: number;
                contentType: string;
                name: string;
                redacted: boolean;
            };
            id?: string;
            links?: { related: string; self: string };
            relationships?: {
                message: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type?: string;
        }[];
    },
    unknown,
    ThrowOnError,
>
Get conversation attachments Retrieves a paginated list of conversation attachments.

Any attachment shared in a conversation via inbound and outbound messages.

Legacy Role Equivalent Permission Set Role

org.user.attachment.read org.permission.attachment.read
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetConversationAttachmentsData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes?: {
                contentLength: number;
                contentType: string;
                name: string;
                redacted: boolean;
            };
            id?: string;
            links?: { related: string; self: string };
            relationships?: {
                message: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type?: string;
        }[];
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:1178

Function getConversationAttachments

Type Parameters

Parameters

Settings