Skip to main content
GET
/
v1
/
users
/
{userId}
/
apis
Get mock APIs accessible to a user
curl --request GET \
  --url https://wmc.wiremockapi.cloud/v1/users/{userId}/apis \
  --header 'Authorization: <api-key>'
{
  "links": {
    "self": "/v1/users/9gd5l/apis?limit=20&page=1"
  },
  "meta": {
    "start": 1,
    "end": 1,
    "total": 1,
    "page": 1,
    "totalPages": 1
  },
  "mockApis": [
    {
      "id": "63om1",
      "aclObject": "1z6rd",
      "name": "Example Mock API",
      "description": "An API consisting of assorted stubs.",
      "state": "RUNNING",
      "adminSecurityEnabled": true,
      "exportState": "EXPORT_ALLOWED",
      "createdDate": "2024-08-23T20:15:32.432385Z",
      "openApiGitIntegration": "63om1-openapi-integration-git",
      "links": {
        "self": "/v1/mock-apis/63om1",
        "requests": "/v1/mock-apis/63om1/requests",
        "mappings": "/v1/mock-apis/63om1/mappings",
        "scenarios": "/v1/mock-apis/63om1/scenarios",
        "recordings": {
          "start": "/v1/mock-apis/63om1/recordings/start",
          "stop": "/v1/mock-apis/63om1/recordings/stop",
          "status": "/v1/mock-apis/63om1/recordings/status",
          "snapshot": "/v1/mock-apis/63om1/recordings/snapshot"
        },
        "imports": "/v1/mock-apis/63om1/imports",
        "organisation": "/v1/organisations/mgk7g",
        "aclObject": "/v1/acl/objects/1z6rd",
        "aclRoles": "/v1/acl/objects/1z6rd/roles",
        "invitations": "/v1/mock-apis/63om1/invitations",
        "acl": "/v1/mock-apis/63om1/acl{?subjectId}",
        "versionHistoryCommits": "/v1/mock-apis/63om1/version-history/commits"
      },
      "baseUrl": "https://63om1.wiremockapi.cloud",
      "domainNames": [
        {
          "domainName": "63om1.wiremockapi.cloud",
          "urls": [
            {
              "url": "https://63om1.wiremockapi.cloud"
            },
            {
              "url": "http://63om1.wiremockapi.cloud"
            }
          ]
        }
      ],
      "domains": [
        "63om1.wiremockapi.cloud"
      ]
    }
  ],
  "aclObjects": [
    {
      "id": "1z6rd",
      "objectType": "mock-api",
      "name": "Example Mock API",
      "aclGrants": [
        "9gd5l-1z6rd-mock_api_admin"
      ],
      "links": {
        "self": "/v1/acl/objects/1z6rd",
        "grants": "/v1/acl/grants?aclObjectId=1z6rd"
      }
    }
  ],
  "openApiGitIntegrations": []
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

Your API key prefixed by 'Token '

Path Parameters

​
userId
string
required

Query Parameters

​
q
string

A filter for the retrieved items. Only items whose name contains the filter value will be retrieved. The filter is case insensitive.

​
sort
string
default:-createdDate

Comma-separated list of sort fields. Prefix with - for descending order. Supported fields: name, createdDate.

​
subjectType
enum<string>

Filter mock APIs by ACL subject type. Must be used together with subjectId.

Available options:
team,
user
​
subjectId
string

Filter mock APIs by ACL subject ID. Must be used together with subjectType.

​
limit
integer
Required range: x >= 1
​
page
integer
Required range: x >= 1

Response

200 response

​
mockApis
object[]
required
​
meta
object
​
links
object