Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $inlinecount String Query-String Specifies that the response to the request should include a count of the number of entries in the collection
    $skip Integer Query-String The number of entries to skip from the beginning of the collection
    $top Integer Query-String The number of entries to return from the beginning of the collection
    ActiveUsersFilter ActiveUsersFilter Query-String Optional. Controls what users to be included in terms of active/inactive. Default is all users.
    ClientKey ClientKey Query-String Unique key identifying the owner. This is the ClientKey of the client under which the list of users belongs. Default: Logged-in user's client.
    IncludeSubUsers Boolean Query-String Optional. Set to true if users of all underlying partners should be included in output.
  • Response Parameters

    View Response Codes
    Name Type Description
    __count Number The total count of items in the feed.
    __next String The link for the next page of items in the feed.
    Data UserResponse [] The collection of entities for this feed.
    MaxRows Number The maximum number of rows that can be returned (if applicable).
  • Request Example

    Request URL
    GET /port/v1/users?$inlinecount=AllPages&$skip=1&$top=1&ActiveUsersFilter=All&ClientKey=493b43a5-fe85-4d1f-9071-dd4a9d4e42a4&IncludeSubUsers=True
  • Response Example

    Response body
    {
      "Data": [
        {
          "Active": true,
          "ClientKey": "V-B8jOk9SM8QdqN1u2Bjtw==",
          "Culture": "en-GB",
          "Language": "en",
          "LastLoginStatus": "Successful",
          "LastLoginTime": "2024-04-04T22:17:22.338861Z",
          "LegalAssetTypes": [
            "FxSpot",
            "Stock",
            "ContractFutures"
          ],
          "MarketDataViaOpenApiTermsAccepted": false,
          "Name": "Mr. Anthony Test",
          "TimeZoneId": 28,
          "UserId": "654321",
          "UserKey": "V-B8jOk9SM8QdqN1u2Bjtw=="
        }
      ],
      "MaxRows": 99
    }