---
title: "Retrieves an association object using a unique object ID"
method: GET
path: "/Associations/{ObjectId}"
tags: ["Files"]
---

# Retrieves an association object using a unique object ID

`GET /Associations/{ObjectId}`

By passing in the appropriate options, you can retrieve an association

## Path parameters

- `ObjectId` string, uuid, required

## Query parameters

- `pagesize` integer
- `page` integer
- `sort` 'Name' | 'Size' | 'CreatedDateUtc' | 'AssociationDateUtc'
- `direction` 'ASC' | 'DESC'

## Response `200`

search results matching criteria

- Association[]
  - `SendWithObject` boolean — Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint.
  - `Name` string — The name of the associated file. Note- The Name element is only returned when using /Associations/{ObjectId} endpoint.
  - `Size` integer — The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/{ObjectId} endpoint.
  - `CreatedDateUtc` string, date-time — The date the file was created (UTC). Note- The CreatedDateUtc element is only returned when using /Associations/{ObjectId} endpoint.
  - `AssociationDateUtc` string, date-time — The date the file was associated with the object (UTC). Note- The AssociationDateUtc element is only returned when using /Associations/{ObjectId} endpoint.
  - `FileId` string, uuid — The unique identifier of the file
  - `ObjectId` string, uuid — The identifier of the object that the file is being associated with (e.g. InvoiceID, BankTransactionID, ContactID)
  - `ObjectGroup` 'Account' | 'BankTransaction' | 'Contact' | 'CreditNote' | 'Invoice' | 'Item' | 'ManualJournal' | 'Overpayment' | 'Payment' | 'Prepayment' | 'Quote' | 'Receipt' — The Object Group that the object is in. These roughly correlate to the endpoints that can be used to retrieve the object via the core accounting API.
  - `ObjectType` 'Unknown' | 'Accpay' | 'AccPayCredit' | 'AccPayPayment' | 'AccRec' | 'AccRecCredit' | 'AccRecPayment' | 'Adjustment' | 'ApCreditPayment' | 'ApOverPayment' | 'ApOverPaymentPayment' | 'ApOverPaymentSourcePayment' | 'ApPrepayment' | 'ApPrepaymentPayment' | 'ApPrepaymentSourcePayment' | 'ArCreditPayment' | 'ArOverPayment' | 'ArOverpaymentPayment' | 'ArOverpaymentSourcePayment' | 'ArPrepayment' | 'ArPrepaymentPayment' | 'ArPrepaymentSourcePayment' | 'CashPaid' | 'CashRec' | 'ExpPayment' | 'ManJournal' | 'PurchaseOrder' | 'Receipt' | 'Transfer' | 'Account' | 'Contact' | 'Business' | 'Employee' | 'Person' | 'User' | 'Org' | 'FixedAsset' | 'PayRun' | 'PriceListItem' | 'Bank' | 'Current' | 'Equity' | 'Expense' | 'Fixed' | 'Liability' | 'Prepayment' | 'Revenue' | 'Sales' | 'Overheads' | 'Depreciatn' | 'OtherIncome' | 'DirectCosts' | 'Currliab' | 'Termliab' | 'NonCurrent' | 'SalesQuote' — The Object Type

---

[API](https://skmtc.net/xeroapi/apis/xero-files-api.md) · [All operations](https://skmtc.net/xeroapi/apis/xero-files-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xeroapi/xero-files-api/versions/64c08f9a8548/schema)
