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
    IncludeSecrets Boolean Query-String Optional set to true to include secrets
  • 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 AppWithSecretsDto [] 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 /developer/apps?$inlinecount=AllPages&$skip=1&$top=1&IncludeSecrets=False
  • Response Example

    Response body
    {
      "Data": [
        {
          "AppKey": "stringValue",
          "Brandings": [
            {
              "Description": "stringValue",
              "Id": 99,
              "Name": "stringValue"
            }
          ],
          "CreatedBy": {
            "Name": "stringValue",
            "UserKey": "stringValue"
          },
          "Description": "stringValue",
          "Endpoints": {
            "AuthorizationEndpoint": "stringValue",
            "TokenEndpoint": "stringValue"
          },
          "Flow": "stringValue",
          "IsActive": false,
          "IsTradingEnabled": true,
          "ManualOrderIndicationDefault": "stringValue",
          "ManualOrderIndicator": "stringValue",
          "Name": "stringValue",
          "Secrets": [
            {
              "Secret": "stringValue",
              "SecretId": 99,
              "ValidFrom": "0001-01-01T00:00:00Z",
              "ValidUntil": "0001-01-01T00:00:00Z"
            }
          ],
          "Status": "Requestable"
        }
      ],
      "MaxRows": 99
    }