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

UserClouds Purposes API

The Purposes API from UserClouds — 3 operation(s) for purposes.

UserClouds Purposes API is one of 8 APIs that UserClouds publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Purposes. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

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

Requests are made against a single base URL, https://your-tenant-name.tenant.userclouds.com.

6 operations 3 paths 10 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://your-tenant-name.tenant.userclouds.com
Resource Areas
1

Paths & Operations 6

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

Purposes 6
POST
/userstore/api/consentedpurposes
List Purposes for User
postUserstoreApiConsentedpurposes body → 200400500
GET
/userstore/config/purposes
List Purposes
getUserstoreConfigPurposes 7 params → 200400500
POST
/userstore/config/purposes
Create Purpose
postUserstoreConfigPurposes body → 201400409500
DELETE
/userstore/config/purposes/{id}
Delete Purpose
deleteUserstoreConfigPurposesById 1 param → 204400404409500
GET
/userstore/config/purposes/{id}
Get Purpose
getUserstoreConfigPurposesById 1 param → 200404500
PUT
/userstore/config/purposes/{id}
Update Purpose
putUserstoreConfigPurposesById 1 param body → 200400404409500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are IdpListPurposesResponse (5 properties), UserstorePurpose (4 properties), UserstoreResourceID (2 properties), IdpGetConsentedPurposesForUserRequest (2 properties). Each schema is shown below with its type and property counts.

UuidUUID
string
UserstorePurpose
object
4 properties 1 required
IdpListPurposesResponse
object
5 properties
IdpCreatePurposeRequest
object
1 property
UserstoreResourceID
object
2 properties
IdpColumnConsentedPurposes
object
2 properties
UserstoreUpdatePurposeRequest
object
1 property
IdpGetConsentedPurposesForUserRequest
object
2 properties
PaginationCursor
IdpGetConsentedPurposesForUserResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

userclouds-purposes-api-openapi.yml Raw ↑

Other APIs UserClouds publishes across the network.

UserClouds Accessors API
UserClouds Column Retention Durations API
UserClouds Columns API
UserClouds Data Types API
UserClouds Mutators API
UserClouds User Search Indices API
UserClouds Users API
Where this information came from

This is an independent, third-party profile of UserClouds Purposes 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.