How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AppZen User Groups API

The User Groups API from AppZen — 3 operation(s) for user groups.

AppZen User Groups API is one of 19 APIs that AppZen publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Groups. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 2.0.3.

Requests are made against a single base URL, https://.appzen.com/dictionary-data-services.

3 operations 3 paths 16 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.3
Base URL
https://api.appzen.com/dictionary-data-services
Authentication
API Key, API Key, API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 6

AppZen User Groups API declares 6 security schemes for authenticating requests. An API key is passed in the header as x-api-key (API_Key_Header). An API key is passed in the header as customer-id (Customer_Id_Header). An API key is passed in the header as customer-key (Customer_Key_Header). An API key is passed in the header as x-api-key (API Key Header). An API key is passed in the header as customer-id (Customer Id Header). An API key is passed in the header as customer-key (Customer Key Header). By default, every request must be authenticated.

Paths & Operations 3

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

User Groups 3
GET
/user-groups
Returns all user groups for the customer
→ 200400401403404500
POST
/user-group
Creates/updates a user group
1 param → 200201400401403404500
GET
/user-group/{external-group-id}
Returns a user group
1 param → 200400401403404500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are user-group (18 properties), user-group-json-schema (12 properties), user-group-member (6 properties), user-group-sync-result (5 properties). Each schema is shown below with its type and property counts.

http-403-error-response
object
4 properties
user-group-sync-result
object
Result of a create/update (POST) operation.
5 properties
date-time
string
date should be in UTC format
user-group
object
A user group as returned by the API.
18 properties
http-500-error-response
object
4 properties
http-401-error-response
object
4 properties
user-group-json-schema
object
Request body for creating/updating a user group.
12 properties 4 required
group-notification-method
string
How notifications are delivered to the group.
group-category
string
Purpose of the group.
http-400-error-response
object
4 properties
group-management-source
string
Who owns the group.
user-group-member-input
object
A group member to assign.
1 property 1 required
group-product
string
AppZen product the group belongs to.
user-group-member
object
A group member as returned by the API.
6 properties
group-status
string
Lifecycle status of the group.
http-404-error-response
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

appzen-user-groups-api-openapi.yml Raw ↑

Other APIs AppZen publishes across the network.

AppZen Chart of Accounts API
AppZen Custom Data Sets API
AppZen Documents API
AppZen Entities API
AppZen Externally Processed Invoices API
AppZen Goods Receipt API
AppZen Invoice Audit Results API
AppZen Invoice Status Sync API
AppZen Invoices API
AppZen Lookup Item API
AppZen Lookup Table API
AppZen Payment Terms API
Where this information came from

This is an independent, third-party profile of AppZen User Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.