API Reference
Doc HomeSupport

list relationships

post
https://api-examples.tamr.cloud/api/v1alpha1/relationships:list

Fetch a page of relationships.

At least one of relationshipTypeId, tableId, fromTableId, or toTableId must be provided.
If recordId, fromRecordId, or toRecordId is specified then tableId, fromTableId, or toTableId must be specified, respectively.

Body Params
query
object

A query to filter relationships. If multiple query parameters are provided, they are combined with AND.

int32

Optional. The maximum number of relationships to return. Default is 100. Maximum is 1000.

string

Optional. Token to retrieve a specific page of relationships. Empty to retrieve the first page.
Set this value to continue paging.

Response

Updated 23 days ago

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

Updated 23 days ago

© 2025, Tamr, Inc. All rights reserved.

License Agreement | Privacy Policy | Data Security Policy| AI Chatbot Disclaimer