Manage Users

Updated

Use the user management endpoints to invite users to an account, list users, transfer ownership, and remove users.

Authentication

Headers

Name Type Description
Authorization string Token <token>

Invite a User

Endpoint

POST https://app.searchstax.com/api/rest/users/

Query Parameters

Name Type Description
account string Your account name.
searchstudio string Set to True to add the user to Site Search.

Headers

Name Type Description
Content-Type string application/json.

Body Parameters

Name Type Description
email string User email. Required.
role string Admin. Required.
first_name string Optional.
last_name string Optional.

Request

Use this curl request to invite a new user. 

curl -s -X POST \
  -H "Authorization: Token <token>" \
  -H "Content-Type: application/json" \
  "https://app.searchstax.com/api/rest/users/?account=<account_name>&searchstudio=True" \
  -d '{
    "email": "user@example.com",
    "role": "Admin",
    "first_name": "First",
    "last_name": "Last"
  }'

Response

The response includes:

Name Type Description
success boolean true or false.
message string Status message.
id string User-account relationship ID (returned on success).

The response looks like this: 

{
  "id": 12345,
  "message": "User 'user@example.com' invited successfully.",
  "success": true
}

List Users

Endpoint

GET https://app.searchstax.com/api/rest/users/

Query Parameters

Name Type Description
account string Your account name. Required.
id string User ID. Optional.
email string User email. Optional.

Request 

curl -s \
  -H "Authorization: Token <token>" \
  "https://app.searchstax.com/api/rest/users/?account=<account_name>"

Response

The response includes:

Name Type Description
success boolean true or false.
users array Array of users, including firstname, lastname, email, id, role, tfa_enabled, last_login, and invitation_status.

The response looks like this: 

{
  "success": true,
  "users": [
    {
      "company": "SearchStax",
      "created": "2025-08-05T14:35:50Z",
      "email": "user.one@example.com",
      "firstname": "User",
      "id": 98,
      "invitation_status": "Completed",
      "last_login": "2026-01-13T01:41:18Z",
      "lastname": "One",
      "phone": null,
      "role": "Admin",
      "role_in_organization": "Engineer",
      "sitesearch_role": "Admin",
      "tfa_enabled": true
    },
    {
      "company": null,
      "created": "2025-11-05T23:15:57Z",
      "email": "user.two@example.com",
      "firstname": "User",
      "id": 34483,
      "invitation_status": "Completed",
      "last_login": "2026-01-13T18:14:34Z",
      "lastname": "Two",
      "phone": null,
      "role": "Admin",
      "role_in_organization": "",
      "sitesearch_role": "Admin",
      "tfa_enabled": false
    }
  ]
}

Remove a User

Endpoint

DELETE https://app.searchstax.com/api/rest/users/

Query Parameters

Name Type Description
account string Your account name.
id string The user ID to remove.

Request 

curl -s -X DELETE \
  -H "Authorization: Token <token>" \
  "https://app.searchstax.com/api/rest/users/?account=<account_name>&id=<user_id>"

Response

The response includes:

Name Type Description
success boolean true or false.
message string Status message.

The response looks like this: 

[
  {
    "message": "was deleted successfully",
    "name": "",
    "success": true
  }
]
Articles in this section