Automation Hub api guide

Last updated May 6, 2026

DELIVERY:

Retrieve a User Account

The following request exemplifies how to retrieve the user accounts within your tenant that match the following criteria:

search for all users accounts from the tenant where the name is set to “Jane”: s=jane

Note:

The API base URL format varies by deployment environment. For the correct base URL for your environment, see Introduction to the Automation Hub API.

GET: https://<accessURL>/{orgName}/{tenantName}/automationhub_/api/v1/openapi/users?s=jane

Request

 Content-Type: application/json
    Authorization: Bearer [Tenant ID/Token]
  x-ah-openapi-app-key: [API key if added]
  x-ah-openapi-auth: openapi-token
 Content-Type: application/json
    Authorization: Bearer [Tenant ID/Token]
  x-ah-openapi-app-key: [API key if added]
  x-ah-openapi-auth: openapi-token

Response

  "message": "Success",
    "statusCode": 200,
    "data": {
        "page": 1,
        "pageSize": 4,
        "totalItems": 4,
        "totalPages": 1,
        "users": [
            {
                "user_email": "jane.doe@email",
                "user_first_name": "Jane",
                "user_last_name": "Doe",
                "user_location": "Brooklyn",
                "user_department": "Engineering",
                "user_business_unit": "Product",
                "user_job_title": "Developer",
                "user_is_active": 1,
                "user_invite_status": 2,
                "user_roles": [
                    {
                      "role_id": 6,
                      "category_id": 0
                     },
                     {
                       "role_id": 4,
                       "category_id": 0
                      },
                      {
                       "role_id": 5,
                       "category_id": 3
        }
      ]
    }
  "message": "Success",
    "statusCode": 200,
    "data": {
        "page": 1,
        "pageSize": 4,
        "totalItems": 4,
        "totalPages": 1,
        "users": [
            {
                "user_email": "jane.doe@email",
                "user_first_name": "Jane",
                "user_last_name": "Doe",
                "user_location": "Brooklyn",
                "user_department": "Engineering",
                "user_business_unit": "Product",
                "user_job_title": "Developer",
                "user_is_active": 1,
                "user_invite_status": 2,
                "user_roles": [
                    {
                      "role_id": 6,
                      "category_id": 0
                     },
                     {
                       "role_id": 4,
                       "category_id": 0
                      },
                      {
                       "role_id": 5,
                       "category_id": 3
        }
      ]
    }

Was this page helpful?

PREVIOUSUpdate Automation Idea Phase and Status

NEXTUpdate Account Details for Employees from Automation Hub