Users

This provides access to you view and create users

Get a User by ID

GET https://api.scopemaster.com/api/v1/users/{ID}

If found, returns an array of one user object.

{
    "seconds": "0.03770",
    "users": [
        {
            "id": "1",
            "first_name": "Charlie",
            "last_name": "French",
            "email": "[email protected]",
            "active": "1",
            "org_id": "OR30c8746905",
            "last_login": "2024-09-16T13:10:09+00:00",
            "is_org_admin": true
        }
   ],
    "links": {
        "self": "https://api.scopemaster.com/api/v1/users/1"
    }
}

Get a User by Email

GET https://api.scopemaster.com/api/v1/[email protected]

Returns the same output structure as get by ID.

Get all Users

Returns all your users .

GET https://api.scopemaster.com/api/v1/users  

Example response :

{
    "seconds": "0.03770",
    "users": [
        {
            "id": "1",
            "first_name": "Charlie",
            "last_name": "French",
            "email": "[email protected]",
            "active": "1",
            "org_id": "OR30c8746905",
            "last_login": "2024-09-16T13:10:09+00:00",
            "is_org_admin": true
        },
        {
            "id": "11",
            "first_name": "Jim-bob",
            "last_name": "Smith",
            "email": "[email protected]",
            "active": "1",
            "org_id": "OR30c8746905",
            "last_login": "2023-06-08T18:02:41+00:00",
            "is_org_admin": false
        }
        
    ],
    "links": {
        "self": "https://api.scopemaster.com/api/v1/users"
    }
}

Create a User

POST https://api.scopemaster.com/api/v1/users  

Once created the individual must then set their password by following the password reset steps, i.e. forgotten password.

Example POST json payload:

      {
            "first_name": "Jim-bob",
            "last_name": "Smith",
            "email": "[email protected]",
        }

Response:

Returns the user object with a generated ID value and your org_id.

 {    
      "seconds": "0.03770",
      "user": 
     {
            "id": "4456",
            "first_name": "Jim-bob",
            "last_name": "Smith",
            "email": "[email protected]",
            "org_id": "OR30c8746905",
            "active": "1",
            "is_org_admin": false
        }
}