Get file relations by entity

Retrieves the file relations for a given entity, each including the linked file's details. Results are paginated.

Staff access is scoped to the linked entity: a staff sees relations for any entity they can access, regardless of who uploaded the file. Client access is scoped to the client's own relations. In both cases, no access to the entity is not an error — it returns an empty list (total: 0), indistinguishable from the entity genuinely having no relations.

Available for Staff and Client tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

Type of entity to fetch relations for (e.g., "invoice", "message", "meeting").

Allowed:
string
required

Unique identifier of the entity to fetch relations for (e.g., "inv_123abc").

integer
≥ 1
Defaults to 1

Page number for pagination (default: 1).

integer
≥ 1
Defaults to 20

Number of relations per page (default: 20).

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json