List partnerships
GET {{baseUrl}}/entities/partnerships
Retrieve all stored partnerships.
Pagination options are available via the query parameters.
Allowed roles : EDITOR
, VIEWER
and SHARER
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
pageToken | string | The pageToken parameter identifies a specific PageModel in the result set that should be returned. | |
In an API response, the nextPageToken and prevPageToken properties identify other PageModels that could be retrieved. | |||
limit | number | (Optional query) Limit the number of results. |
Accepts a positive integer between 1
and 100
. Default: 100
Note that the sever may choose to ignore this parameter and use a lower value.
Example: 20
|
| sort
| string | | (Optional query) Sorting order |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
tangany-version | number | (Required) API version | |
Accept | string | ||
_tangany-data | string |
RESPONSES
status: OK
{"items":[{"id":"78c483d7-5e6d-488b-981c-2ac4bccca2a5","name":"Joint account","members":[{"entityId":"d","sharePercentage":"50"},{"entityId":"ullamco","sharePercentage":"50"}],"address":{"country":"GB","city":"SOUTHAMPTON","postcode":"SO53 5PD","streetName":"71 Cherry Court","streetNumber":"A. 813"}},{"id":"78c483d7-5e6d-488b-981c-2ac4bccca2a5","name":"Joint account","members":[{"entityId":"ut magna in dolor commodo","sharePercentage":"50"},{"entityId":"aliqua in ipsum","sharePercentage":"50"}],"address":{"country":"GB","city":"SOUTHAMPTON","postcode":"SO53 5PD","streetName":"71 Cherry Court","streetNumber":"A. 813"}}],"nextPageToken":"NDg2ODg=","pageInfo":{"totalResults":-49028244.82982844,"resultsPerPage":-67870445.24488932}}