Skip to content
v2 API/
/
Return folders list share...

V2 API

Download OpenAPI description
SCALA-API.openapi.json
SCALA-API.openapi.yaml
Languages
Servers
https://api.observepoint.com/v2/

Tags

Endpoints for managing tags and tag-related operations including tag metadata and configuration

Operations

Rules

Endpoints for managing rules including creation, configuration, assignment, and rule-based validation logic

Operations

Audits

Endpoints for managing audits including creation, configuration, execution, and retrieving audit results and runs

Operations

Sub-Folders

Endpoints for managing sub-folders including creation, configuration, and sub-folder-based audit and journey management

Operations

Manual Journeys

Endpoints for managing manual journeys including real device testing, HAR file ingestion, and journey execution control. These endpoints power Live Connect and HAR Analyzer features in the ObservePoint UI, enabling users to perform manual testing on real devices and analyze HAR files for tag validation and troubleshooting.

For more information, see the HAR File Processing API Recipe.

Operations

Account

Endpoints for managing account settings, configurations, and account-level information

Operations

Users

Endpoints for managing users including creation, authentication, permissions, and user account management

Operations

Return all users for current user account.

Request

GET /v2/users
Security
API_Key
Query
withDeletedboolean

Include deleted users

Default false
curl -i -X GET \
  'https://api.observepoint.com/v2/users?withDeleted=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [
accountIdinteger(int32)required
createdstring(date-time)required
deletedstring

ISO 8601 date time string with offset when user was deleted, null if not deleted

emailstringrequired
firstNamestringrequired
fullUsageDashboardAccessbooleanrequired
idinteger(int32)required
lastLoginstring(date-time)
lastNamestringrequired
maxPagesPerAuditinteger(int32)required
permissionsstring
Enum"guest""user""admin"
timezonestringrequired
updatedstring(date-time)required
usernamestringrequired
]
Response
application/json
[
  {
    "accountId": 0,
    "created": "2019-08-24T14:15:22Z",
    "deleted": "string",
    "email": "string",
    "firstName": "string",
    "fullUsageDashboardAccess": true,
    "id": 0,
    "lastLogin": "2019-08-24T14:15:22Z",
    "lastName": "string",
    "maxPagesPerAudit": 0,
    "permissions": "guest",
    "timezone": "string",
    "updated": "2019-08-24T14:15:22Z",
    "username": "string"
  }
]

Create new user.Accessible only for admin users

Request

POST /v2/users
Security
API_Key
Bodyapplication/jsonrequired

New user data

emailstringrequired
firstNamestringrequired
fullUsageDashboardAccessnumber
lastNamestringrequired
maxPagesPerAuditnumber
permissionsstring
Enum"guest""user""admin"
timezonestringrequired
usernamestringrequired
curl -i -X POST \
  https://api.observepoint.com/v2/users \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "firstName": "string",
    "fullUsageDashboardAccess": 0,
    "lastName": "string",
    "maxPagesPerAudit": 0,
    "permissions": "guest",
    "timezone": "string",
    "username": "string"
  }'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
createdstring(date-time)required
deletedstring

ISO 8601 date time string with offset when user was deleted, null if not deleted

emailstringrequired
firstNamestringrequired
fullUsageDashboardAccessbooleanrequired
idinteger(int32)required
lastLoginstring(date-time)
lastNamestringrequired
maxPagesPerAuditinteger(int32)required
permissionsstring
Enum"guest""user""admin"
timezonestringrequired
updatedstring(date-time)required
usernamestringrequired
Response
application/json
{
  "accountId": 0,
  "created": "2019-08-24T14:15:22Z",
  "deleted": "string",
  "email": "string",
  "firstName": "string",
  "fullUsageDashboardAccess": true,
  "id": 0,
  "lastLogin": "2019-08-24T14:15:22Z",
  "lastName": "string",
  "maxPagesPerAudit": 0,
  "permissions": "guest",
  "timezone": "string",
  "updated": "2019-08-24T14:15:22Z",
  "username": "string"
}

Return user data by given id. Accessible only for admin users or if {userId} equal to current user id

Request

GET /v2/users/{userId}
Security
API_Key
Path
userIdinteger(int32)required
curl -i -X GET \
  'https://api.observepoint.com/v2/users/{userId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
createdstring(date-time)required
deletedstring

ISO 8601 date time string with offset when user was deleted, null if not deleted

emailstringrequired
firstNamestringrequired
fullUsageDashboardAccessbooleanrequired
idinteger(int32)required
lastLoginstring(date-time)
lastNamestringrequired
maxPagesPerAuditinteger(int32)required
permissionsstring
Enum"guest""user""admin"
timezonestringrequired
updatedstring(date-time)required
usernamestringrequired
Response
application/json
{
  "accountId": 0,
  "created": "2019-08-24T14:15:22Z",
  "deleted": "string",
  "email": "string",
  "firstName": "string",
  "fullUsageDashboardAccess": true,
  "id": 0,
  "lastLogin": "2019-08-24T14:15:22Z",
  "lastName": "string",
  "maxPagesPerAudit": 0,
  "permissions": "guest",
  "timezone": "string",
  "updated": "2019-08-24T14:15:22Z",
  "username": "string"
}

Update user data by given userId.Accessible only for admin users or if {userId} equal to current user id

Request

PUT /v2/users/{userId}
Security
API_Key
Path
userIdinteger(int32)required
Bodyapplication/jsonrequired

Updated user data

emailstringrequired
firstNamestringrequired
fullUsageDashboardAccessnumber
lastNamestringrequired
maxPagesPerAuditnumber
permissionsstring
Enum"guest""user""admin"
timezonestringrequired
usernamestringrequired
curl -i -X PUT \
  'https://api.observepoint.com/v2/users/{userId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "firstName": "string",
    "fullUsageDashboardAccess": 0,
    "lastName": "string",
    "maxPagesPerAudit": 0,
    "permissions": "guest",
    "timezone": "string",
    "username": "string"
  }'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
createdstring(date-time)required
deletedstring

ISO 8601 date time string with offset when user was deleted, null if not deleted

emailstringrequired
firstNamestringrequired
fullUsageDashboardAccessbooleanrequired
idinteger(int32)required
lastLoginstring(date-time)
lastNamestringrequired
maxPagesPerAuditinteger(int32)required
permissionsstring
Enum"guest""user""admin"
timezonestringrequired
updatedstring(date-time)required
usernamestringrequired
Response
application/json
{
  "accountId": 0,
  "created": "2019-08-24T14:15:22Z",
  "deleted": "string",
  "email": "string",
  "firstName": "string",
  "fullUsageDashboardAccess": true,
  "id": 0,
  "lastLogin": "2019-08-24T14:15:22Z",
  "lastName": "string",
  "maxPagesPerAudit": 0,
  "permissions": "guest",
  "timezone": "string",
  "updated": "2019-08-24T14:15:22Z",
  "username": "string"
}

Delete user by given id. Accessible only for admin users

Request

DELETE /v2/users/{userId}
Security
API_Key
Path
userIdinteger(int32)required
curl -i -X DELETE \
  'https://api.observepoint.com/v2/users/{userId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Item was successfully deleted

Return folders list shared with user by given id. Accessible only for admin users or if {userId} equal to current user id

Request

GET /v2/users/{userId}/folders
Security
API_Key
Path
userIdinteger(int32)required
curl -i -X GET \
  'https://api.observepoint.com/v2/users/{userId}/folders' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [
accountIdinteger(int32)required
idinteger(int32)required
namestringrequired
]
Response
application/json
[
  {
    "accountId": 0,
    "id": 0,
    "name": "string"
  }
]

Add given folders as shared for user with given userId.Accessible only for admin users

Request

POST /v2/users/{userId}/folders
Security
API_Key
Path
userIdinteger(int32)required
Bodyapplication/json

Folders id list

Array [
integer(int32)
]
curl -i -X POST \
  'https://api.observepoint.com/v2/users/{userId}/folders' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    0
  ]'

Responses

successful operation

Bodyapplication/jsonArray [
accountIdinteger(int32)required
idinteger(int32)required
namestringrequired
]
Response
application/json
[
  {
    "accountId": 0,
    "id": 0,
    "name": "string"
  }
]

Set given folders as shared for user with given userId. Accessible only for admin users

Request

PUT /v2/users/{userId}/folders
Security
API_Key
Path
userIdinteger(int32)required
Bodyapplication/json

Folders id list

Array [
integer(int32)
]
curl -i -X PUT \
  'https://api.observepoint.com/v2/users/{userId}/folders' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    0
  ]'

Responses

successful operation

Bodyapplication/jsonArray [
accountIdinteger(int32)required
idinteger(int32)required
namestringrequired
]
Response
application/json
[
  {
    "accountId": 0,
    "id": 0,
    "name": "string"
  }
]

Labels

Endpoints for managing labels including creation, assignment, and retrieval for organizing audits, journeys, and other resources

Operations

Folders

Endpoints for managing folders including creation, organization, access control, and folder-based resource management

Operations