Engagedly User Attributes API
Retrieve system and custom user attribute definitions
Engagedly User Attributes API is one of 8 APIs that Engagedly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include User Attributes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 1 operation across 1 path, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version beta.
Requests are made against a single base URL, https://api.engagedly.com/beta.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Engagedly User Attributes API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as ClientKey (clientKeyAuth).
An API key is passed in the header as SecretKey (secretKeyAuth).
By default, every request must be authenticated.
clientKeyAuth— Client key obtained from the Engagedly portal under Integrations Engagedly APIsecretKeyAuth— Secret key obtained from the Engagedly portal. Shown only once upon generation.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Retrieve system and custom user attribute definitions
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are UserAttribute (7 properties), ErrorDetail (3 properties), UserAttributeListResponse (2 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Engagedly 7
Other APIs Engagedly publishes across the network.