Company relationships [GET]
Operation
This endpoint returns the relationships available in the pms for a profile and its subsidiary
GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/company/relationships
Request
Property | Type | Required | Path parameter | Default value | Description |
---|---|---|---|---|---|
chainId | Integer | true | path parameter | Unique identificator of the chain. | |
chainProfileRelationshipTypeId | Integer | false | request parameter | Filter available to reduce the results to only one type of relationship |
Example request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/company/relationships
Response
Property | Type | Required | Description |
---|---|---|---|
Page | Page | true | Description of the response of the success operation |
Entity
Field Type Required Description profileId Integer true profileSubsidiaryId Integer true
Example response
{ "count": 2, "offset": 0, "limit": 2, "list": [{ "profileId": 20, "profileSubsidiaryId": 21 }, { "profileId": 20, "profileSubsidiaryId": 22 } ] }