Endpoint
scenarios
Allows a user to retrieve all projects associated with the specified API key. API keys are unique to each user and account.
Type
GET
Request Parameters
- Optional
project: The identifier of a specific project obtained from the project list endpoint, provided as a url parameter to the GET request.
Responses
-
200 OK: Successfully retrieved the list of scenarios -
404 Not Found: No scenarios found
The response is a JSON array of objects with details of the scenarios associated to the api key, and if provided the specific project.
Example Request
curl --location 'https://intermx-prod.apigee.net/v1/scenarios?project=67f93188127def0013f5bb79' \
--header 'apikey: {YOUR API KEY HERE}'Example Response
{
"pagination": {
"total": 366,
"page": 1,
"perPage": 10,
"pageSize": 10
},
"results": [
{
"_id": "67fd89a398c90f0012429fcc",
"name": "Atlantic City Boardwalk - 2024-12-31",
"description": "Atlantic City Boardwalk - 2024-12-31",
"createdAt": "2025-04-14T22:18:11.612Z",
"updatedAt": "2025-04-14T22:18:11.804Z"
},
{
"_id": "67fd8997ebf1d60012f67e2b",
"name": "Atlantic City Boardwalk - 2024-12-22",
"description": "Atlantic City Boardwalk - 2024-12-22",
"createdAt": "2025-04-14T22:17:59.797Z",
"updatedAt": "2025-04-14T22:18:00.021Z"
}
]
}