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 imports API

The imports API from Resourcly — 6 operation(s) for imports.

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

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

This API exposes 10 operations across 6 paths, and defines 15 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.

10 operations 6 paths 15 schemas 2 DELETE3 GET5 POST

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 imports 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 10

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

imports 10
GET
/imports
List import jobs
2 params → 200401500
POST
/imports
Create import job
4 params → 201401500
POST
/imports/validate
Validate upload paths against the folder mapping
1 param → 200400401
GET
/imports/{id}
Get import job
1 param → 200400401404
DELETE
/imports/{id}
Delete import job
1 param → 200400401404500
GET
/imports/{id}/documents
Get import documents
4 params → 200400401404
POST
/imports/{id}/documents
Upload document to import
2 params → 202400401404500
DELETE
/imports/{id}/documents
Delete import documents
1 param → 200400401404500
POST
/imports/{id}/rerun
Re-run import job
1 param → 200400401404500
POST
/imports/{id}/retrigger
Retrigger import documents
2 params → 200400401404500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are models.ImportJob (21 properties), models.Document (17 properties), models.DocumentUploadWithImportResponse (5 properties), models.ImportJobDocumentsResponse (5 properties). Each schema is shown below with its type and property counts.

models.ImportJobDeleteResponse
object
3 properties
models.ImportJobRetriggerResponse
object
3 properties
models.ImportJobOptions
object
1 property
models.ImportJobRerunResponse
object
4 properties
models.DocumentUploadWithImportResponse
object
5 properties
models.ValidateImportFileResult
object
4 properties
models.ImportJobListResponse
object
4 properties
models.ImportJobRetriggerRequest
object
2 properties
models.ErrorResponse
object
3 properties
models.ImportJobCreateResponse
object
2 properties
models.ValidateImportFilesRequest
object
2 properties
models.Document
object
17 properties
models.ImportJob
object
21 properties
models.ValidateImportFilesResponse
object
1 property
models.ImportJobDocumentsResponse
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

resourcly-imports-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 documents API
Resourcly drive API
Resourcly duplicates API
Resourcly email API
Resourcly feedback API
Resourcly health API