| Route | Description |
|---|---|
| GET /orgs/:orgId | Get details of the organization |
| GET /orgs/:orgId/scheduled | Get list scheduled test configurations for Organization |
| GET /scheduled | Get list of scheduled test configurations |
Overview
API routes related to organization.
Get details of the organization
Get detail of the organization
GET /orgs/:orgId
Request Parameters
orgId: ID of the organization
Sample Response
{
"data": {
"id": 2,
"createdAt": "2017-02-27T09:14:31.033Z",
"updatedAt": "2021-11-10T03:54:03.113Z",
"name": "demo@testable.io",
"email": "demo@testable.io",
"settings": {
"reassignOnFail": "true",
"percentiles": "50,90,95,99,99.9",
"hasPlaywrightSettings": "false",
"isGcpEnabledAllRegions": "false",
"hasCustomNpmrc": "true",
"tracesEnabled": "true",
"tcSort": "lastRun",
"gcpRegionsSelected": [
{
"name": "us-west1",
"description": "West US 1"
}
],
"cleanupPolicy": "IntelligentSampling",
"showActiveTestTraffic": "true",
"filter": "all",
"isAzureEnabled": "true",
"onlyCaptureFailure": "true",
"hasCustomOpenFin": "false",
"groupBy": "scenario",
"isAwsEnabledAllRegions": "true",
"tcFilter": "all",
"region": "587",
"tcGroupBy": "scenario",
"hasMvnSettings": false,
"isAwsEnabled": "true",
"layout": "minimal",
"selfHostedOnly": "false",
"tcLayout": "minimal",
"sort": "lastRun",
"encryptionKey": "xxx",
"isAzureEnabledAllRegions": "true",
"encryptionSource": 7,
"isGcpEnabled": "true"
},
"paymentGateway": "Stripe",
"stripeCustomerId": "xxx",
"stripeSubscriptionId": "xxx",
"isPlanAnnual": false,
"public": false,
"shared": false,
"active": true,
"awsCustomerId": "xxx",
"creditBalance": {
"id": 1,
"createdAt": "2017-02-27T09:14:32.556Z",
"updatedAt": "2021-11-11T06:16:48.081Z",
"discountSharedPrivate": 10,
"discountOnDemandPrivate": 10,
"discountSharedPublic": 0,
"discountOnDemandPublic": 0,
"costPerCredit": 7.5,
"monthlyCredits": 120,
"monthlyCreditsRemaining": 118.4375,
"paidCredits": 0,
"minCredits": -1000,
"currentCredits": 0,
"currentAmount": 0,
"months": [
202110
],
"balanceAlertSent": false,
"externalInvoiceId": "xxx",
"externalInvoiceUrl": "xxxx",
"externalInvoicePaid": true,
"externalInvoiceAttempts": 1,
"externalInvoiceStatus": "paid",
"elasticIps": {
"aws": {
"byRegion": [
{
"region": "us-east-1",
"ips": [
{
"ip": "xx.xx.xxx.xx",
"id": "xxxx-xx"
}
]
}
]
}
},
"licensedAgents": 1,
"paidCreditEntries": [
{
"id": 5,
"createdAt": "2020-07-22T21:41:25.000Z",
"updatedAt": "2020-12-30T20:48:07.992Z",
"expiringAt": "2021-01-01T00:00:00.000Z",
"creditsLeft": 40,
"parentId": 1,
"firstVersion": false
}
],
"firstVersion": false
},
"users": [
{
"user": {
"id": 1,
"createdAt": "2017-02-27T09:14:30.869Z",
"updatedAt": "2021-11-11T06:18:51.449Z",
"lastLoggedIn": "2021-11-11T06:18:51.449Z",
"name": "Demo Time",
"email": "demo@testable.io",
"accessType": "Admin",
"confirmed": true,
"active": true,
"authSource": "Password",
"authSubdomain": ""
},
"userRole": "Admin"
}
],
"testCases": [
{
"id": 269,
"createdAt": "2020-10-13T16:26:20.517Z",
"updatedAt": "2020-10-13T16:26:20.518Z",
"name": "AAA",
"active": true,
"metricDefs": [],
"running": [],
"scheduled": [],
"todaySuccessHistory": [],
"yesterdaySuccessHistory": [],
"note": {
"id": 181,
"createdAt": "2020-10-13T16:26:20.827Z",
"updatedAt": "2020-10-13T16:26:20.827Z",
"noteType": "Description",
"contents": "",
"contentsHtml": "",
"testCaseId": 269,
"organizationId": 2,
"firstVersion": true
},
"tags": [],
"firstVersion": true
}
],
"plan": {
"id": 4,
"createdAt": "2017-02-27T09:03:34.140Z",
"updatedAt": "2017-02-27T09:03:34.140Z",
"name": "Pro",
"price": 599,
"stripeId": "mpro",
"isPublic": true,
"description": "[\"120 Monthly Credits\",\n\"$7.50 per Additional Credit\",\n\"Unlimited Results Retention\",\n\"100GB Storage\",\n\"Gold Email Support\"]",
"discountSharedPrivate": 10,
"discountOnDemandPrivate": 10,
"discountSharedPublic": 0,
"discountOnDemandPublic": 0,
"costPerCredit": 7.5,
"monthlyCredits": 120,
"minCredits": -1000,
"annualPrice": 4788,
"annualStripeId": "apro",
"licensedAgents": 0,
"organizations": [],
"firstVersion": true
},
"hasLinkedOrgs": true
}
}
Get list scheduled test configurations for Organization
Retrieve list of all scheduled test configurations for organization
GET /orgs/:orgId/scheduled
Request Parameters
orgId: ID of the organization
Sample Response
[
{
"id": 1,
"createdAt": "2021-11-12T05:55:18.137Z",
"updatedAt": "2021-11-12T05:55:18.137Z",
"nextScheduled": "2021-11-15T06:55:00.000Z",
"scheduleType": "Single",
"active": true,
"configuration": {
"id": 1394,
"createdAt": "2021-11-12T05:55:17.934Z",
"updatedAt": "2021-11-12T05:55:18.076Z",
"testType": "Load",
"name": "TES-645",
"durationSecs": 60,
"iterationSleepSecs": 10,
"rampupSecs": 60,
"concurrentClients": 1,
"profileType": "Flat",
"scriptParams": "{}",
"isTryItOut": false,
"active": true,
"hasChanged": false,
"expectedNumRegions": 1,
"expectedActualConcurrentClientRatio": 1,
"outputFileRetention": "IntelligentSampling",
"outputFileMaxCount": 1000,
"minCredits": 0.06250,
"onlyCaptureFailure": true,
"imageDiffMode": "PreviousExecution",
"manualStart": false,
"testCase": {
"id": 422,
"createdAt": "2021-09-08T17:04:48.165Z",
"updatedAt": "2021-11-10T07:11:13.940Z",
"name": "Tar Test",
"active": true,
"lastRunAt": "2021-11-10T07:10:55.030Z",
"lastRunExecutionId": 10873,
"tags": [],
"firstVersion": false
},
"executions": [],
"script": {
"id": 9713,
"createdAt": "2021-09-08T17:05:03.903Z",
"updatedAt": "2021-09-08T17:05:03.912Z",
"name": "HTTP GET",
"dataLength": 32,
"hasInit": false,
"hasTeardown": false,
"paramsConfig": [],
"scriptType": "Code",
"readonly": false,
"dataStores": [],
"configurations": [],
"tags": [],
"firstVersion": true
},
"providers": [
{
"id": 4866,
"createdAt": "2021-11-12T05:55:18.112Z",
"updatedAt": "2021-11-12T05:55:18.112Z",
"numRegions": 1,
"params": {
"regions": "1",
"concurrentClients": "1",
"weight": "100"
},
"provider": {
"id": 1,
"createdAt": "2017-02-27T09:03:33.102Z",
"updatedAt": "2017-02-27T09:03:33.102Z",
"name": "Public Shared Grid",
"public": true,
"providerType": "Shared",
"metadata": {},
"active": true,
"locations": [],
"firstVersion": true
},
"firstVersion": true
}
]
}
}
]
Get list of scheduled test configurations
Retrieve a list of all scheduled test configurations.
GET /scheduled
Request Parameters
None
Sample Response
[
{
"id": 1,
"createdAt": "2021-11-12T05:55:18.137Z",
"updatedAt": "2021-11-12T05:55:18.137Z",
"nextScheduled": "2021-11-15T06:55:00.000Z",
"scheduleType": "Single",
"active": true,
"configuration": {
"id": 1394,
"createdAt": "2021-11-12T05:55:17.934Z",
"updatedAt": "2021-11-12T05:55:18.076Z",
"testType": "Load",
"name": "Demo",
"durationSecs": 60,
"iterationSleepSecs": 10,
"rampupSecs": 60,
"concurrentClients": 1,
"profileType": "Flat",
"script": {
"id": 9713,
"createdAt": "2021-09-08T17:05:03.903Z",
"updatedAt": "2021-09-08T17:05:03.912Z",
"name": "HTTP GET",
"dataLength": 32,
"hasInit": false,
"hasTeardown": false,
"paramsConfig": [],
"scriptType": "Code",
"readonly": false,
"dataStores": [],
"configurations": [],
"tags": [],
"firstVersion": true
},
"providers": [
{
"id": 4866,
"createdAt": "2021-11-12T05:55:18.112Z",
"updatedAt": "2021-11-12T05:55:18.112Z",
"numRegions": 1,
"params": {
"regions": "1",
"concurrentClients": "1",
"weight": "100"
},
"provider": {
"id": 1,
"createdAt": "2017-02-27T09:03:33.102Z",
"updatedAt": "2017-02-27T09:03:33.102Z",
"name": "Public Shared Grid",
"public": true,
"providerType": "Shared",
"metadata": {},
"active": true,
"locations": [],
"firstVersion": true
},
"firstVersion": true
}
],
},
"exclusions": []
}
]