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

Resourcly documents API

The documents API from Resourcly — 4 operation(s) for documents.

Resourcly documents API is one of 22 APIs that Resourcly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 5 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://api.resourcly.com/v1.

5 operations 4 paths 4 schemas 1 DELETE4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://api.resourcly.com/v1
Authentication
API Key
License
Proprietary
Terms of Service
Resource Areas
1

Authentication & Security 1

Resourcly documents API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (BearerAuth).

  • BearerAuth — Firebase JWT token. Format: "Bearer {token}"

Paths & Operations 5

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

documents 5
GET
/documents
List documents
2 params → 200401500
GET
/documents/{id}
Get document
1 param → 200400401404
DELETE
/documents/{id}
Delete document
1 param → 204400401500
GET
/documents/{id}/download
Download document
1 param → 200400401404500
GET
/documents/{id}/url
Get document URL
2 params → 200400401404500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are models.Document (17 properties), models.EmbedURLResponse (7 properties), models.DocumentListResponse (4 properties), models.ErrorResponse (3 properties). Each schema is shown below with its type and property counts.

models.EmbedURLResponse
object
7 properties
models.Document
object
17 properties
models.ErrorResponse
object
3 properties
models.DocumentListResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

resourcly-documents-api-openapi.yml Raw ↑

Other APIs Resourcly publishes across the network.

Resourcly analytics API
Resourcly auth API
Resourcly bom-comparisons API
Resourcly boms API
Resourcly business API
Resourcly datasources API
Resourcly drive API
Resourcly duplicates API
Resourcly email API
Resourcly feedback API
Resourcly health API
Resourcly imports API