Users API

Axiom users API retrieves all of the users in a specified organization and returns their emails, IDs, and names associated with the personal token.

Example Request

GET api.axiom.co/v1/users

curl -X 'GET' \
  'https://api.axiom.co/v1/users' \
  -H 'Authorization: Bearer <$PERSONAL_TOKEN>' \
  -H 'X-Axiom-Org-ID: <$ORG-ID>'

Example Response

Response code 200 and the response body:

[
    {
        "id": "string",
        "name": "string",
        "email": "string",
        "role": "admin",
        "permissions": [
            "CanIngest",
            "CanQuery",
            "CanUpdate",
            "ChangeAccess",
            "ChangeApiKeys",
            "ChangeAuthentication",
            "ChangeDashboards",
            "ChangeIntegrations",
            "ChangeMonitorsAndNotifiers",
            "ChangeSavedQueries",
            "ChangeVirtualFields",
            "ManageAPITokens",
            "ManageDatasets",
            "ManageEndpoints",
            "ManageSharedAccessKeys"
        ]
    },
    {
        "id": "string",
        "name": "string",
        "email": "string",
        "role": "owner",
        "permissions": [
            "CanIngest",
            "CanQuery",
            "CanUpdate",
            "ChangeAccess",
            "ChangeApiKeys",
            "ChangeAuthentication",
            "ChangeDashboards",
            "ChangeIntegrations",
            "ChangeMonitorsAndNotifiers",
            "ChangeSavedQueries",
            "ChangeVirtualFields",
            "ManageAPITokens",
            "ManageBilling",
            "ManageDatasets",
            "ManageEndpoints",
            "ManageSharedAccessKeys"
        ]
    }

User API

Axiom user API retrieves the user and returns the email, ID, and name associated with the personal token.

Example Request

GET /api/v1/user

curl -X 'GET' \
  'https://api.axiom.co/v1/user' \
  -H 'Authorization: Bearer <$PERSONAL_TOKEN>'

Example Response

Response code 200 and the response body:

{
    "id": "string",
    "name": "string",
    "emails": [
        "string"
    ]
}

Was this page helpful?