Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ActivTrak Administration API

Administer the ActivTrak account (clients, consumers). Beta.

ActivTrak Administration API is one of 4 APIs that ActivTrak publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Administration. The published artifact set on APIs.io includes an OpenAPI specification, a changelog, API documentation, and an API reference.

This API exposes 6 operations across 3 paths. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against 5 base URLs: https://api.activtrak.com, https://api-eu.activtrak.com, https://api-uk.activtrak.com, https://api-ca.activtrak.com, https://api-au.activtrak.com.

6 operations 3 paths 0 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.activtrak.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

ActivTrak Administration API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Public API key sent in the x-api-key header. Some endpoints also accept Authorization: Bearer {apiKey}. Keys are created in the ActivTrak app under API & Integ…

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Administration 6

Administer the ActivTrak account (clients, consumers). Beta.

GET
/admin/v1/clients
This API call returns a paged list of Clients. It returns the first page with up to 50 clients.
getAllClients → 200400401
POST
/admin/v1/consumers
Create Consumers from the list provided. Response shall contain a list of success, falures and warning/error messages.
createConsumers body → 200400401
DELETE
/admin/v1/consumers
Delete Consumers from the list provided. Response shall contain a list of success, falures and warning/error messages.
deleteConsumers → 200400401
GET
/admin/v1/consumers
This returns a list of all Consumers. The optional paramater includeViewableGroups will return the list of Groups th
getAllConsumers 1 param → 200400401
PATCH
/admin/v1/consumers
PatchConsumers from the list provided. Response shall contain a list of success, falures and warning/error messages.
patchConsumers body → 200400401
GET
/admin/v1/consumers/{id}
Given an ID, this returns a Consumer. If the consumer is not found, a StatusResponse object is returned indicating the
getConsumer 1 param → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activtrak-administration-api-openapi.yml Raw ↑

Other APIs ActivTrak publishes across the network.

ActivTrak Administration - SCIM API
ActivTrak Bulk Import API
ActivTrak Reports API