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: Self (logged in) or Site Admin (for any user).

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

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

Request URL

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

Sample request headers

Accept: application/vnd.soa.v71+json
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

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

Back to top

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).
IncludeTags Query boolean Optional Indicates whether tags should be returned in the response. If not specified, defaults to false.

Back to top

Response

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

Back to top

Sample Response

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

Sample response headers: application/vnd.soa.v71+json

Status Code: 200 OK
Content-Type: application/vnd.soa.v71+json
Expires: Wed, 01 Apr 2015 20:11:08 GMT

Sample response body: application/vnd.soa.v71+json

{
  "Application" : [ {
    "AppID" : "b788f118-1789-4d8b-9744-8ab2970db482.acmepaymentscorp",
    "Name" : "Helpify",
    "Description" : "Documentation app",
    "Visibility" : "Public",
    "DefaultVersionID" : "AciO7I7uhJQYNVL7q40iu5Ur.acmepaymentscorp",
    "Created" : "2015-04-02T01:05:42Z",
    "Updated" : "2015-04-02T01:05:43Z",
    "TeamID" : "appteam-b788f118-1789-4d8b-9744-8ab2970db482.acmepaymentscorp",
    "Image" : {
      "Url" : "http://{hostname}/api/apps/b788f118-1789-4d8b-9744-8ab2970db482.acmepaymentscorp/avatar"
    },
    "Connections" : 2,
    "Followers" : 1,
    "Rating" : 0.0
  }, {
    "AppID" : "e6bc6955-4d8a-40db-a0f9-6a232d7a239a.acmepaymentscorp",
    "Name" : "AinmhitheLookup",
    "Description" : "Animal names in other languages",
    "Visibility" : "Public",
    "DefaultVersionID" : "4k2rSDPSkMA7F0QMIiKu6V5B.acmepaymentscorp",
    "Created" : "2015-04-02T01:05:15Z",
    "Updated" : "2015-04-02T01:05:16Z",
    "TeamID" : "appteam-e6bc6955-4d8a-40db-a0f9-6a232d7a239a.acmepaymentscorp",
    "Image" : {
      "Url" : "http://{hostname}/api/apps/e6bc6955-4d8a-40db-a0f9-6a232d7a239a.acmepaymentscorp/avatar"
    },
    "Connections" : 2,
    "Followers" : 1,
    "Rating" : 0.0
  }, {
    "AppID" : "ce195b40-fa2f-4855-8ac7-169fc9a3c16e.acmepaymentscorp",
    "Name" : "crosfhocal",
    "Description" : "s",
    "Visibility" : "Public",
    "DefaultVersionID" : "8CwiZZtw5PC4KXxBbkL7YT7D.acmepaymentscorp",
    "Created" : "2015-04-01T16:28:44Z",
    "Updated" : "2015-04-01T19:06:12Z",
    "TeamID" : "appteam-ce195b40-fa2f-4855-8ac7-169fc9a3c16e.acmepaymentscorp",
    "Image" : {
      "Url" : "http://{hostname}/api/apps/ce195b40-fa2f-4855-8ac7-169fc9a3c16e.acmepaymentscorp/avatar"
    },
    "Connections" : 1,
    "Followers" : 3,
    "Rating" : 0.0
  } ]
}

Back to top

Sample response headers: application/vnd.soa.v72+xml

Status Code: 200 OK
Content-Type: application/vnd.soa.v72+xml
Expires: Wed, 01 Apr 2015 20:13:29 GMT

Sample response body: application/vnd.soa.v72+xml

<?xml version="1.0" encoding="UTF-8"?>
<Applications xmlns="http://soa.com/xsd/app/1.0" xmlns:ns2="http://soa.com/xsd/resource/1.0" 
xmlns:ns3="http://soa.com/xsd/dnmodel/1.0">
  <Application>
    <AppID>b788f118-1789-4d8b-9744-8ab2970db482.acmepaymentscorp</AppID>
    <Name>Helpify</Name>
    <Description>Documentation app</Description>
    <Visibility>Public</Visibility>
    <DefaultVersionID>AciO7I7uhJQYNVL7q40iu5Ur.acmepaymentscorp</DefaultVersionID>
    <Created>2015-04-02T01:05:42Z</Created>
    <Updated>2015-04-02T01:05:43Z</Updated>
    <TeamID>appteam-b788f118-1789-4d8b-9744-8ab2970db482.acmepaymentscorp</TeamID>
    <ns3:Image>
      <ns3:Url>http://{hostname}/api/apps/b788f118-1789-4d8b-9744-8ab2970db482.acmepaymentscorp/avatar</ns3:Url>
    </ns3:Image>
    <Connections>2</Connections>
    <Followers>1</Followers>
    <Rating>0.0</Rating>
  </Application>
  <Application>
    <AppID>e6bc6955-4d8a-40db-a0f9-6a232d7a239a.acmepaymentscorp</AppID>
    <Name>AinmhitheLookup</Name>
    <Description>Animal names in other languages</Description>
    <Visibility>Public</Visibility>
    <DefaultVersionID>4k2rSDPSkMA7F0QMIiKu6V5B.acmepaymentscorp</DefaultVersionID>
    <Created>2015-04-02T01:05:15Z</Created>
    <Updated>2015-04-02T01:05:16Z</Updated>
    <TeamID>appteam-e6bc6955-4d8a-40db-a0f9-6a232d7a239a.acmepaymentscorp</TeamID>
    <ns3:Image>
      <ns3:Url>http://{hostname}/api/apps/e6bc6955-4d8a-40db-a0f9-6a232d7a239a.acmepaymentscorp/avatar</ns3:Url>
    </ns3:Image>
    <Connections>2</Connections>
    <Followers>1</Followers>
    <Rating>0.0</Rating>
  </Application>
  <Application>
    <AppID>ce195b40-fa2f-4855-8ac7-169fc9a3c16e.acmepaymentscorp</AppID>
    <Name>crosfhocal</Name>
    <Description>s</Description>
    <Visibility>Public</Visibility>
    <DefaultVersionID>8CwiZZtw5PC4KXxBbkL7YT7D.acmepaymentscorp</DefaultVersionID>
    <Created>2015-04-01T16:28:44Z</Created>
    <Updated>2015-04-01T19:06:12Z</Updated>
    <TeamID>appteam-ce195b40-fa2f-4855-8ac7-169fc9a3c16e.acmepaymentscorp</TeamID>
    <ns3:Image>
      <ns3:Url>http://{hostname}/api/apps/ce195b40-fa2f-4855-8ac7-169fc9a3c16e.acmepaymentscorp/avatar</ns3:Url>
    </ns3:Image>
    <Connections>1</Connections>
    <Followers>3</Followers>
    <Rating>0.0</Rating>
  </Application>
</Applications>

Back to top

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

Back to top

Response Body

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

Back to top

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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics