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

Interos Groups API

The Groups API from Interos — 2 operation(s) for groups.

Interos Groups API is one of 5 APIs that Interos publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Groups. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

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

Requests are made against a single base URL, https://api.interos.ai.

2 operations 2 paths 21 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0.0
Base URL
https://api.interos.ai
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Interos Groups API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (Interos API Key). An API key is passed in the header as x-customer-id (Interos Customer ID). By default, every request must be authenticated.

Paths & Operations 2

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

Groups 2
GET
/v1/organization_groups
Get All Groups For Customer
get_all_for_customer_v1_external_organization_groups_get 3 params → 200401403404422
GET
/v1/organization_groups/{group_id}/organizations
Get Organizations For Group
get_organizations_for_group_v1_external_organization_groups__group_id__organizations_get 7 params → 200401403404422

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Organization (32 properties), RestrictedList (12 properties), Address (9 properties), RiskFactorScore (8 properties). Each schema is shown below with its type and property counts.

ScoreLevel
string
An enumeration.
OrganizationList
object
3 properties
OrganizationGroupList
object
3 properties
RiskAttribute
object
7 properties 2 required
Segment
string
An enumeration.
ForbiddenError
object
1 property
RestrictedList
object
12 properties 2 required
Address
object
9 properties
ValidationError
object
3 properties 3 required
ProductCategory
object
2 properties
OrganizationGroupBase
object
2 properties 2 required
RiskVariableScore
object
8 properties 3 required
RiskFactorScore
object
8 properties 3 required
UnauthorizedError
object
1 property
Organization
object
32 properties 2 required
IScore
object
2 properties
HTTPValidationError
object
1 property
RiskProfile
object
2 properties 1 required
OrganizationGroup
object
8 properties 6 required
HTTPError
object
1 property 1 required
Score
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

interos-groups-api-openapi.yml Raw ↑

Other APIs Interos publishes across the network.

Interos health API
Interos Organizations API
Interos Relationships API
Interos Watchtower API