GET /api/users/{UserID}/apis

Returns a list of APIs for the specified user. Includes information about the APIs that the specified user is connected to; for example, as an API Administrator, API Scope Group member, or as an app team member for an app that's subscribed to the API. The information is returned as a JSON object.

Valid in version: 2020.1.0 and later.

Note: Use this operation rather than GET /api/users/{UserID}/apis (with different Accept header values) which returns the results in the form of an RSS channel.

Authorization Roles/Permissions: Must be logged in. Self only.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/users/apis

Sample Request

Request URL #1

Returns all APIs for the specified user.

https://{hostname}/api/users/31af17ef-38e5-4dc2-9b50-92dad8aa7fa7.acmepaymentscorp/apis

Request URL #2

Returns the first two APIs for the specified user.

https://{hostname}/api/users/31af17ef-38e5-4dc2-9b50-92dad8aa7fa7.acmepaymentscorp/apis?count=2

Sample request headers

Accept: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	application/vnd.akana.v2020+json
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.
count	Query	integer	Optional	The number of results to be returned. If not specified, all matching results are returned.

Response

If successful, this operation returns HTTP status code 200, with information about the APIs for the specified user in JSON format.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: application/vnd.akana.v2020+json
Date: Wed, 29 Jul 2020 14:21:05 GMT

Sample response body

{
  "API": [
    {
      "APIID": "37c792db-e763-4abf-a6c1-2dd2ecc47b7f.acmepaymentscorp",
      "Name": "Swagger_Petstore_5_Operations",
      "Description": "Swagger_Petstore_5_Operations. Based on http://petstore.swagger.io/v2/swagger.json with deletions in API Designer.",
      "Visibility": "Public",
      "LatestVersionID": "ef8e5dd5-3036-4342-97ec-98232cc36899.acmepaymentscorp",
      "Tag": [
        "store",
        "user",
        "pet"
      ],
      "Created": "2020-07-29T13:56:19Z",
      "Updated": "2020-07-29T13:56:19Z",
      "InUserTop": true
    },
    {
      "APIID": "b5662e48-8bb0-421a-9838-fe13cf4c70df.acmepaymentscorp",
      "Name": "httpbin",
      "Description": "httpbin",
      "Visibility": "Public",
      "LatestVersionID": "6b0a6f4c-3d2e-4fa0-aaa1-f619a360f8ec.acmepaymentscorp",
      "Created": "2020-07-29T13:55:27Z",
      "Updated": "2020-07-29T13:55:27Z",
      "InUserTop": true
    }
  ]
}

Response Headers

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

Header	Description
Content-Type	application/vnd.akana.v2020+json

Response Body

Name	Type	Description
APIs	APIs	Contains information about one or more APIs.

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

More information about Akana API Platform API error messages.

Related Topics