GET /api/users/{UserID}/apps

Returns information about the apps for which the user is on the app team, and optionally also information about app versions. The information is returned as a JSON object.

Note: Use this operation rather than GET /api/users/{UserID}/apps (with Accept header of application/json, text/xml, or application/rss+xml) which returns the results in the form of an RSS channel.

Authorization Roles/Permissions: Must be logged in. Self (logged in) or Site Admin (for any user).

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/users/{UserID}/apps[?IncludeVersions=boolean][&start=int][&count=int][&VersionCount=int]
[&LimitToConnectedAppsWithAPIVersion={APIVersionID}][&LimitToAppsWithActivatedConnections={boolean}]
[&LimitToConnectedAppsInEnvironment={environment}]

Sample Request

The example below shows a request for the apps associated with a specific user.

Request URL #1

The example below shows a request for the apps associated with a specific user. No optional request parameters are used.

For the response, see Sample response body #1 below.

https://{hostname}/api/users/00904729-ae54-4a91-94bb-bde91ec6495d.acmepaymentscorp/apps

Request URL #2

The example below shows a request for the apps associated with a specific user. In this example, tags are also requested.

For the response, see Sample response body #2 below.

https://{hostname}/api/users/00904729-ae54-4a91-94bb-bde91ec6495d.acmepaymentscorp/apps?IncludeTags=true

Sample request headers 

Accept: application/vnd.soa.v81+json

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml
Cookie AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter Parm Type Data Type Required Description
UserID Path string Required The unique ID for a specific user.
IncludeVersions Query boolean Optional Indicates whether information about app versions should be included in the results. Defaults to false, so app versions are not included unless this parameter is set to true.
start Query integer Optional An index number indicating the starting point for the results to be returned. If not specified, results start at position 0, the first result.
count Query integer Optional The number of results to be returned, from the specified starting point. If not specified, all matching results are returned.
versionCount Query integer Optional Indicates the number of versions to be included in the results. If not specified, defaults to 0, so versions are not included.
LimitToConnectedAppsWithAPIVersion Query string Optional Limits the results to apps that are connected with the specified APIVersionID.
LimitToAppsWithActivatedConnections Query boolean Optional Indicates whether results should be limited to apps that have activated connections. If set to False, apps with connections in all states are included.
LimitToConnectedAppsInEnvironment Query string Optional Limits the results to apps that are connected in the specified environment (Sandbox or Production).

Response

If successful, this operation returns HTTP status code 200, with information about the apps for which the user is on the app team.

Sample Response

The sample response below shows successful completion of this operation. The specified user has two apps.

Sample response headers 

Status Code: 200 OK
Content-Type: application/vnd.soa.v81+json
Expires: Tue, 09 Apr 2019 21:09:24 GMT

Sample response body #1

The example below shows the response to Request URL #1 (no optional parameters included). The user has two apps.

{
  "Application":[
    {
      "AppID":"98dd5f5d-dea6-4c10-a873-1b708e80fa0c.acmepaymentscorp",
      "Name":"Jenga",
      "Description":"Puzzle game",
      "Summary":"Puzzle game",
      "Visibility":"Public",
      "DefaultVersionID":"k7j4fJHm61HZkJSpZJBTk1c8t7adgjyV1JjXUIBS.acmepaymentscorp",
      "Created":"2019-04-09T19:52:34Z",
      "Updated":"2019-04-09T19:52:35Z",
      "TeamID":"appteam-98dd5f5d-dea6-4c10-a873-1b708e80fa0c.acmepaymentscorp",
      "Image":{
        "Url":"http://test.acmepaymentscorp.com/api/apps/avatar/_VTSYjyKyfCubBKF8selZU1g"
      },
      "Connections":0,
      "Followers":1,
      "Rating":0
    },
    {
      "AppID":"f44f511f-e743-4148-8fdf-dd79f0c4bd0e.acmepaymentscorp",
      "Name":"Peile Android",
      "Description":"Game app for Android phones",
      "Summary":"Game app",
      "Visibility":"Public",
      "DefaultVersionID":"jQW0pyRIlPTp4zILah5yWnoL2Z7xYtnQCJUbZjcq.acmepaymentscorp",
      "Created":"2019-04-09T18:57:22Z",
      "Updated":"2019-04-09T19:13:09Z",
      "TeamID":"appteam-f44f511f-e743-4148-8fdf-dd79f0c4bd0e.acmepaymentscorp",
      "Image":{
        "Url":"http://test.acmepaymentscorp.com/api/apps/avatar/_VTSYjyKyfCubBKF8selZU1g"
      },
      "Connections":0,
      "Followers":1,
      "Rating":0
    }
  ]
}

Sample response body #2

The example below shows the response to Request URL #2. The user is the same as in the previous example, with two apps. However, the request includes the optional IncludeTags parameter, so tags are included in the response.

{
    "Application": [
        {
            "AppID": "98dd5f5d-dea6-4c10-a873-1b708e80fa0c.acmepaymentscorp",
            "Name": "Jenga",
            "Description": "Puzzle game",
            "Summary": "Puzzle game",
            "Visibility": "Public",
            "DefaultVersionID": "k7j4fJHm61HZkJSpZJBTk1c8t7adgjyV1JjXUIBS.acmepaymentscorp",
            "Tag": [
                "game",
                "puzzle"
            ],
            "Created": "2019-04-09T19:52:34Z",
            "Updated": "2019-04-09T19:52:35Z",
            "TeamID": "appteam-98dd5f5d-dea6-4c10-a873-1b708e80fa0c.acmepaymentscorp",
            "Image": {
                "Url": "http://test.acmepaymentscorp.com/api/apps/avatar/_VTSYjyKyfCubBKF8selZU1g"
            },
            "Connections": 0,
            "Followers": 1,
            "Rating": 0
        },
        {
            "AppID": "f44f511f-e743-4148-8fdf-dd79f0c4bd0e.acmepaymentscorp",
            "Name": "Peile Android",
            "Description": "Game app for Android phones",
            "Summary": "Game app",
            "Visibility": "Public",
            "DefaultVersionID": "jQW0pyRIlPTp4zILah5yWnoL2Z7xYtnQCJUbZjcq.acmepaymentscorp",
            "Tag": [
                "puzzle",
                "language",
                "learning",
                " iOS",
                "Android"
            ],
            "Created": "2019-04-09T18:57:22Z",
            "Updated": "2019-04-09T19:13:09Z",
            "TeamID": "appteam-f44f511f-e743-4148-8fdf-dd79f0c4bd0e.acmepaymentscorp",
            "Image": {
                "Url": "http://test.acmepaymentscorp.com/api/apps/avatar/_VTSYjyKyfCubBKF8selZU1g"
            },
            "Connections": 0,
            "Followers": 1,
            "Rating": 0
        }
    ]
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Response Body

Name Type Description
Applications Applications Contains information about one or more apps.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
406 Not Acceptable. Returned if there is a problem with the request format. For example, you would get this if you specified an incorrect media type for the Accept header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.