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

Ada subpackage_endUsers API

The subpackage_endUsers API from Ada — 2 operation(s) for subpackage_endusers.

Ada subpackage_endUsers API is one of 13 APIs that Ada publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include subpackage_endUsers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 5 base URLs: https://example.ada.support, https://example.att.ada.support, https://example.maple.ada.support, https://example.ficanex.ada.support, https://example.eu.ada.support.

4 operations 2 paths 16 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ada.cx
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Ada subpackage_endUsers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

Paths & Operations 4

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

subpackage_endUsers 4
GET
/v2/end-users/{end_user_id}
Get an end user
get-end-user-by-id 2 params → 200400401404429500
PATCH
/v2/end-users/{end_user_id}
Update an end user
patch-end-user-by-id 2 params body → 200400401404409429500
GET
/v2/end-users/
Get multiple end users
get-end-users 4 params → 200400401404429500
POST
/v2/end-users/
Create an end user
create-end-user 1 param body → 200400401413429500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are EndUserProfile (8 properties), EndUserRequestProfile (8 properties), CreateEndUserRequestProfile (8 properties), EndUser (5 properties). Each schema is shown below with its type and property counts.

EndUserRequest
object
2 properties 1 required
CreateEndUserRequestProfile
object
The end user's profile information. Optional — omitting profile creates a blank end user.
8 properties
EndUserRequestProfile
object
The end user's profile information
8 properties
EndUserRequestProfileSensitiveMetadataFields
EndUser
object
5 properties
CreateEndUserRequestProfileSensitiveMetadataFields
EndUserRequestProfileSensitiveMetadata
object
Sensitive key-value pairs to update on the end user. Values are stored in an encrypted, isolated store and are never returned in any API response, dashboard vi…
1 property 1 required
End Users_getEndUsers_Response_200
CursorPaginationMetadata
object
Metadata returned with the results including but not limited to a link to the next page of data
1 property
EndUsers
object
2 properties
CreateEndUserRequest
object
2 properties
Errors
object
1 property 1 required
ErrorsErrorsItems
object
3 properties 2 required
EndUserProfile
object
The end user's profile information
8 properties
CreateEndUserRequestProfileSensitiveMetadata
object
Sensitive key-value pairs to associate with the end user at creation time. Values are stored in an encrypted, isolated store and are never returned in any API…
1 property 1 required
EndUserProfileSystemProperties
object
Read-only profile information set by Ada
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ada-subpackage-endusers-api-openapi.yml Raw ↑

Other APIs Ada publishes across the network.

Ada End Users API
Ada Conversations API
Ada Integrations API
Ada subpackage_channels API
Ada subpackage_conversations API
Ada subpackage_deleteChatterData API
Ada subpackage_knowledge.subpackage_knowledge/articles API
Ada subpackage_knowledge.subpackage_knowledge/sources API
Ada subpackage_knowledge.subpackage_knowledge/tags API
Ada subpackage_messages API
Ada subpackage_platformIntegrations API
Ada subpackage_webhookManagement API