Skip to main content

Axiom Docs home page

Get started

Introduction
Send data
Query data
Pagination
API limits

Annotation endpoints

GET
List all annotations
GET
Retrieve annotation
POST
Create annotation
PUT
Update annotation
DEL
Delete annotation

API token endpoints

GET
List all API tokens
GET
Retrieve API token
POST
Create API token
POST
Regenerate API token
DEL
Delete API token

Dataset endpoints

GET
List all datasets
GET
Retrieve dataset
GET
List all fields in dataset
GET
Retrieve field in dataset
POST
Create dataset
POST
Ingest data
POST
Run query
POST
Run query (legacy)
POST
Trim dataset
PUT
Update dataset
PUT
Update field
POST
Vacuum dataset
DEL
Delete dataset

Edge endpoints

POST
Ingest data to dataset

Map field endpoints

GET
List all map fields
POST
Create map field
PUT
Update list of map fields
DEL
Delete map fields

Monitor endpoints

GET
List all monitors
GET
Retrieve monitor
GET
Retrieve monitor history
POST
Create monitor
PUT
Update monitor
DEL
Delete monitor

Notifier endpoints

GET
List all notifiers
GET
Retrieve notifier
POST
Create notifier
PUT
Update notifier
DEL
Delete notifier

Organization endpoints

GET
List all orgs
GET
Retrieve org
POST
Create org
PUT
Update org

Role-Based Access Control endpoints

GET
List all roles
GET
Retrieve role
GET
List all groups
GET
Retrieve group
POST
Create role
POST
Create group
PUT
Update role
PUT
Update group
DEL
Delete role
DEL
Delete group

Saved queries endpoints

GET
List all saved queries
GET
Retrieve saved query
POST
Create saved query
PUT
Update saved query
DEL
Delete saved query

User endpoints

GET
Retrieve current user
GET
List all users
GET
Retrieve user
POST
Create user
PUT
Update current user
PUT
Update user role
DEL
Delete user from org

Views endpoints

GET
List all views
GET
Retrieve view
POST
Create view
PUT
Update view
DEL
Delete view

Virtual fields endpoints

GET
List all virtual fields
GET
Retrieve virtual field
POST
Create virtual field
PUT
Update virtual field
DEL
Delete virtual field

Blog
Support
Launch Axiom

Axiom Docs home page

Blog
Support
Launch Axiom
Launch Axiom

Query reference

Query reference

Role-Based Access Control endpoints

List all roles

Retrieves all roles in the organization with their associated permissions and members.

Was this page helpful?

Suggest edits Raise issue

Retrieve roleRetrieves detailed information about a specific role by its unique identifier.

⌘I

x github linkedin discord

Powered by Mintlify