GET {{baseUrl}}/apis?workspaceId=<string>
Gets information about all APIs in a workspace. Note: This endpoint only returns APIs created or migrated in Qodex v10 and higher.
Body
PARAM
Key | Datatype | Required | Description |
workspaceId
|
string | (Required) The workspace ID. | |
createdBy
|
string | The user ID of the user that created the resource. | |
cursor
|
string | The pointer to the first record of the set of paginated results. | |
limit
|
string | The maximum number of rows to return in the response. This value defaults to `10`. | |
description
|
string | Return only APIs whose description includes the given value. Matching is not case-sensitive. |
HEADERS
Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
{
"meta": {
"nextCursor": "V2VkIEZlYiAxNSAyMDIzIDEzOjA3OjA4IEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk=",
"total": 1,
"limit": 10
},
"apis": [
{
"updatedBy": "893478",
"createdBy": "893478",
"name": "New API",
"summary": null,
"description": "This is an API for testing purposes.",
"createdAt": "2023-02-15T06:27:16.000Z",
"id": "73e15000-bc7a-4802-b80e-05fff18fd7f8",
"updatedAt": "2023-02-15T06:27:24.000Z"
}
]
} |
ENDPOINTS