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

Wegalvanize Collections API

A collection is a container used to organize analyses that relate to different departments, business processes, or data sets. Collections are the highest level oforganization in the Results app.Your organization can have a maximum of 2,000 collections.Learn more about collections.

Wegalvanize Collections API is one of 69 APIs that Wegalvanize publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Collections. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 8 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.0.2, at version 1.1.0.

Requests are made against a single base URL, {protocol}://{server}/v1.

8 operations 4 paths 8 schemas 2 DELETE2 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.1.0
Base URL
https://apis-us.highbond.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Wegalvanize Collections API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (oauth2) (bearerToken). By default, every request must be authenticated.

  • bearerToken — HighBond offers the industry-standard OAuth 2.0 flow for connecting to the HighBond platform. OAuth 2.0 provides a safe and secure way to access data, while pr…

Paths & Operations 8

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

Collections 8

A collection is a container used to organize analyses that relate to different departments, business processes, or data sets. Collections are the highest level of organization in…

GET
/orgs/{org_id}/collections
List collections inside an organization
getCollections 1 param → 200400401403404
POST
/orgs/{org_id}/collections
Create a collection
createCollection 1 param body → 201400401403404415422
GET
/orgs/{org_id}/collections/{id}
Get a collection
getCollection 2 params → 200400401403404415
PUT
/orgs/{org_id}/collections/{id}
Update a collection
updateCollection 2 params body → 200400401403404415422
DELETE
/orgs/{org_id}/collections/{id}
Delete a collection
deleteCollection 2 params → 204400401403404415
POST
/orgs/{org_id}/collections/{collection_id}/collections_members
Add a user to Results collection member
postCollectionMember 2 params body → 200400401403404422
PATCH
/orgs/{org_id}/collections/{collection_id}/collections_members/{id}
Update a user role for a collection
patchCollectionMember 3 params body → 200400401403404
DELETE
/orgs/{org_id}/collections/{collection_id}/collections_members/{id}
Remove a user from the collection
deleteCollectionMember 3 params → 204400401403404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Error (5 properties), SingleCollectionResponse (1 property), MultiCollectionsResponse (1 property), Errors (1 property). Each schema is shown below with its type and property counts.

Error
object
5 properties 1 required
UpdateCollectionPayload
object
The data associated with the resource.
1 property 1 required
CreateCollectionPayload
object
The data associated with the resource.
1 property 1 required
CreateCollectionResponse
object
The data associated with the resource.
1 property 1 required
Errors
object
1 property
MultiCollectionsResponse
object
The data associated with the resource.
1 property 1 required
SingleCollectionResponse
object
The data associated with the resource.
1 property 1 required
CollectionMemberRequest
object
The data required to add a member to a collection.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wegalvanize-collections-api-openapi.yml Raw ↑

Other APIs Wegalvanize publishes across the network.

Wegalvanize Actions API
Wegalvanize Activities API
Wegalvanize Analyses API
Wegalvanize Attachments API
Wegalvanize Collaborators API
Wegalvanize Compliance Maps API
Wegalvanize Control performance schedules API
Wegalvanize Control test plans API
Wegalvanize Control tests API
Wegalvanize Controls API
Wegalvanize Custom attributes API
Wegalvanize Entities API