Skip to main content
GET
/
api
/
apis
/
{apiID}
/
access
Get API access rights (users and userGroups)
curl --request GET \
  --url https://{tenant}/api/apis/{apiID}/access \
  --header 'Authorization: Bearer <token>'
{
  "userGroupIds": [
    "663a4ed6b6be920001b191aa",
    "663a4ed6b6be920001b191ab"
  ],
  "userIds": [
    "663b2a835715ecb6edef24e3",
    "663a5bbf5715ec8040251f2a"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://tyk.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Path Parameters

​
apiID
string
required

The API ID

Response

APIAccessManagementPayload represents two lists containing users and user groups that have access to an API

​
userGroupIds
string[]
Example:
[
  "663a4ed6b6be920001b191aa",
  "663a4ed6b6be920001b191ab"
]
​
userIds
string[]
Example:
[
  "663b2a835715ecb6edef24e3",
  "663a5bbf5715ec8040251f2a"
]