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 Components Grants API

The Components Grants API from Extole — 4 operation(s) for components grants.

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

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

This API exposes 5 operations across 4 paths, and defines 4 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.

5 operations 4 paths 4 schemas 1 DELETE2 GET2 POST

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 Components Grants 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 5

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

Components Grants 5
GET
/v1/component-grants
List component grants
listComponentGrants → 200400401402403415429
POST
/v1/component-grants
Grant component access
grantComponent → 200400401402403415429
GET
/v1/component-grants/granters
List component granters
listGranters → 200400401402403415429
POST
/v1/component-grants/all
Grant access to all components
grantAllComponents → 200400401402403415429
DELETE
/v1/component-grants/{grantId}
Revoke a component grant
revokeComponentGrant 1 param → 200400401402403415429

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ComponentGranterResponse (8 properties), ComponentGrantResponse (5 properties), RestExceptionResponse (5 properties). Each schema is shown below with its type and property counts.

ComponentGranterResponse
object
8 properties 8 required
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
ComponentGrantResponse
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-components-grants-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 Settings API
Extole Components Subscriptions API