Attachments

attachments Query

Audience: Programmer

Retrieves a paginated list of attachments with support for filtering and ordering. This query returns all attachments across the system that the user has access to.

Arguments

Name	Type	Description
after	Cursor	Returns elements after the specified cursor for forward pagination
first	Int	Returns the first n elements from the list
before	Cursor	Returns elements before the specified cursor for backward pagination
last	Int	Returns the last n elements from the list
orderBy	AttachmentOrder	Ordering options for the returned attachments
where	AttachmentWhereInput	Filtering criteria for the attachments

Return Type

AttachmentConnection! - A Relay-style connection containing:

• edges: Array of attachment edges with cursor information

• nodes: Array of attachment objects

• pageInfo: Information about pagination (hasNextPage, hasPreviousPage, etc.)

• totalCount: Total number of attachments matching the filter

Usage Example

GraphQL Query

query GetAttachments($first: Int!, $where: AttachmentWhereInput) {
  attachments(first: $first, where: $where) {
    edges {
      node {
        id
        filename
        contentType
        size
        url
        createdAt
        updatedAt
      }
      cursor
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    totalCount
  }
}

Query Variables

{
  "first": 20,
  "where": {
    "contentType": {
      "startsWith": "image/"
    }
  }
}

JavaScript Example

const getAttachments = async (limit = 20, filters = {}) => {
  const query = `
    query GetAttachments($first: Int!, $where: AttachmentWhereInput) {
      attachments(first: $first, where: $where) {
        edges {
          node {
            id
            filename
            contentType
            size
            url
            createdAt
          }
          cursor
        }
        pageInfo {
          hasNextPage
          endCursor
        }
        totalCount
      }
    }
  `;

  const response = await fetch('/graphql', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${accessToken}`
    },
    body: JSON.stringify({
      query,
      variables: { 
        first: limit,
        where: filters
      }
    })
  });

  const { data } = await response.json();
  return data.attachments;
};

// Get all image attachments
const images = await getAttachments(20, {
  contentType: { startsWith: "image/" }
});

// Get attachments created in the last week
const recent = await getAttachments(10, {
  createdAt: { 
    gte: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000).toISOString()
  }
});

Filtering Options

The where parameter supports various filtering options:

// Filter by content type
{
  contentType: { 
    equals: "application/pdf",
    startsWith: "image/",
    in: ["image/jpeg", "image/png"]
  }
}

// Filter by filename
{
  filename: {
    contains: "report",
    startsWith: "invoice_"
  }
}

// Filter by file size
{
  size: {
    gte: 1024,      // Greater than or equal to 1KB
    lte: 10485760   // Less than or equal to 10MB
  }
}

// Filter by creation date
{
  createdAt: {
    gte: "2024-01-01T00:00:00Z",
    lte: "2024-12-31T23:59:59Z"
  }
}

Ordering Options

Sort attachments using the orderBy parameter:

// Sort by creation date (newest first)
{ createdAt: "DESC" }

// Sort by filename (alphabetical)
{ filename: "ASC" }

// Sort by file size (largest first)
{ size: "DESC" }

Related

• nodeAttachments Query

• Attachment Type

• File Management Guide