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

Extole Users API

The Users API from Extole — 8 operation(s) for users.

Extole Users API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 14 operations across 8 paths, and defines 11 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://{brand}.extole.io.

14 operations 8 paths 11 schemas 2 DELETE4 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole Users API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as extole_token (COOKIE). An API key is passed in the header as Authorization (HEADER). An API key is passed in the query as access_token (QUERY). By default, every request must be authenticated.

Paths & Operations 14

Across 8 paths, the API surfaces 14 operations — 2 DELETE, 4 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 14
GET
/v2/users
List users
listUsers 1 param → 200400401402403415429
POST
/v2/users
Create a user
createUser body → 200400401402403415429
GET
/v2/users/{userId}
Get a user
getUser 1 param → 200400401402403415429
PUT
/v2/users/{userId}
Update a user
updateUser 1 param body → 200400401402403415429
DELETE
/v2/users/{userId}
Delete a user
deleteUser 1 param → 200400401402403415429
GET
/v2/users/{user_id}/properties
List user properties
listUserProperties 1 param → 200400401402403415429
POST
/v2/users/{user_id}/properties
Create a user property
createUserProperty 1 param body → 200400401402403415429
GET
/v2/users/{user_id}/properties/{name}
Get a user property
getUserProperty 2 params → 200400401402403415429
PUT
/v2/users/{user_id}/properties/{name}
Update a user property
updateUserProperty 2 params body → 200400401402403415429
DELETE
/v2/users/{user_id}/properties/{name}
Delete a user property
deleteUserProperty 2 params → 200400401402403415429
POST
/v2/users/password-reset
Reset user password
resetUserPassword body → 200400401403415429
POST
/v2/users/resend-invite-email
Resend user invite email
resendUserInviteEmail body → 200400401402403415429
POST
/v2/users/{userId}/unlock
Unlock a user
unlockUser 1 param → 200400401402403415429
PUT
/v2/users/update-password
Update user password
updateUserPassword body → 200400401402403415429

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are UserResponse (7 properties), UserCreationRequest (5 properties), UserUpdateRequest (5 properties), RestExceptionResponse (5 properties). Each schema is shown below with its type and property counts.

UserResponse
object
7 properties 7 required
PasswordResetRequest
object
1 property 1 required
PropertyResponse
object
2 properties 2 required
UserPasswordUpdateRequest
object
Body of a PUT /v2/users/update-password request.
1 property 1 required
ResendInviteEmailRequest
object
1 property 1 required
UserUpdateRequest
object
Body of a PUT /v2/users/{userId} request.
5 properties
PropertyUpdateRequest
object
Body of a PUT /v2/users/{userid}/properties/{name} request.
1 property 1 required
UserCreationRequest
object
5 properties 1 required
PropertyCreationRequest
object
2 properties 2 required
SuccessResponse
object
1 property 1 required
RestExceptionResponse
object
Represents the API error response
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-users-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API