How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pleo external-vendors API

The external-vendors API from Pleo — 13 operation(s) for external-vendors.

Pleo external-vendors API is one of 21 APIs that Pleo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include external-vendors. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 14 operations across 13 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 39.4.0.

Requests are made against 2 base URLs: https://external.pleo.io, https://external.staging.pleo.io.

14 operations 13 paths 28 schemas 3 GET8 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
39.4.0
Base URL
https://external.pleo.io
Authentication
HTTP Bearer, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Pleo external-vendors API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — JWT Bearer token authentication. Include the token in the Authorization header as: Bearer
  • basicAuth — Basic HTTP authentication using API key. Use your API key as the username and leave the password empty. The credentials will be Base64 encoded automatically.

Paths & Operations 14

Across 13 paths, the API surfaces 14 operations — 3 GET, 8 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

external-vendors 14
POST
/v1/vendors
Create a New Vendor
postVendor body → 201409
POST
/v1/vendors/csv-import/jobs
Create an import job
createCsvImportJobV1 body → 201400500
GET
/v1/vendors/csv-import/jobs/{jobId}
Get CSV import job details
getCsvImportJobV1 1 param → 200400404
GET
/v1/vendors/csv-import/jobs/{jobId}/errors
Get import job errors
getCsvImportJobErrorsV1 7 params → 200400404
PUT
/v1/vendors/csv-import/jobs/{jobId}/metadata
Update metadata for CSV import job
updateCsvImportJobMetadataV1 1 param body → 200400404500
PUT
/v1/vendors/csv-import/jobs/{jobId}/status
Update status for CSV import job
updateCsvImportJobStatusV1 1 param body → 200400404500
POST
/v1/vendors/csv-import/jobs/{jobId}:get-presigned-url
Get presigned URL for file upload
getCsvImportJobPresignedUrlV1 1 param → 200400404500
POST
/v1/vendors/csv-import/jobs/{jobId}:run
Run import job
runCsvImportJobV1 1 param → 200400404409
POST
/v1/vendors/csv-import/jobs:search
Search CSV import jobs by filter
searchCsvImportJobsV1 7 params body → 200400
GET
/v1/vendors/{id}
Retrieves a Vendor in Pleo by its id
getVendorById 1 param → 200404
PUT
/v1/vendors/{id}
Update a Vendor
updateVendor 1 param body → 200400404409
POST
/v1/vendors/{id}:activate
Activate a Vendor
activateVendor 1 param body → 204404
POST
/v1/vendors/{id}:archive
Archive a Vendor
archiveVendorById 1 param → 204404
POST
/v1/vendors:search
Fetches Vendors by search criteria
searchVendors 7 params body → 200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are CsvImportJobV1 (17 properties), VendorResponse (13 properties), VendorUpdateRequest (9 properties), VendorCreateRequest (8 properties). Each schema is shown below with its type and property counts.

VendorSearchRequestV1
object
8 properties
CursorPageCurrentRequestInfo
object
7 properties 1 required
CsvRowImportErrorV1
object
7 properties 7 required
DataResponseCsvImportJobV1
object
1 property 1 required
VendorCreateRequest
object
8 properties 3 required
CountryCode
string
Country of registration of the Vendor (ISO 3166-1 alpha-2 country code (2 letters))
PresignedUrlV1
object
1 property 1 required
CursorPaginatedResponseVendorResponse
object
2 properties 2 required
VendorState
string
Current state of the Vendor. ACTIVE means the vendor is in-sync with target ERP/accounting system. DRAFT means the vendor needs to be created in the target ERP…
DataResponsePresignedUrlV1
object
1 property 1 required
CsvImportJobStatusV1
string
Status of CSV import job.
UpdateStatusRequestV1
object
3 properties 1 required
CursorPaginatedResponseCsvRowImportErrorV1
object
2 properties 2 required
CsvImportErrorTypeV1
string
VendorResponse
object
13 properties 5 required
UpdateMetadataStrategyV1
string
UpdateMetadataRequestV1
object
2 properties 2 required
VendorUpdateRequest
object
9 properties 5 required
ExceptionInfo
object
2 properties 1 required
CreateCsvImportJobRequestV1
object
5 properties 3 required
CursorPaginatedResponseCsvImportJobV1
object
2 properties 2 required
CsvImportJobV1
object
17 properties 6 required
ActivateVendorEventRequest
object
The request containing the acknowledgement of the vendor creation in the target ERP/accounting system
2 properties 1 required
DataResponseVendorResponse
object
1 property 1 required
SearchCsvImportJobsRequestV1
object
3 properties
CursorPageInfo
object
6 properties 3 required
CsvFormatV1
object
CSV format configuration including delimiter, quote character, and other parsing options. If not provided for a CSV import job, the parser will try to guess it…
6 properties 4 required
PageOrder
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pleo-external-vendors-api-openapi.yml Raw ↑

Other APIs Pleo publishes across the network.

Pleo accounting-entries API
Pleo accounting-entries-external API
Pleo AccountingEntryEnrichmentV2 API
Pleo Accounts API
Pleo Companies API
Pleo Employees API
Pleo Export API (v0) API
Pleo Export API (v1) API
Pleo Export API (v2) API
Pleo Export API (v3) API
Pleo Export Items (v0) API
Pleo Export Items (v1) API
Where this information came from

This is an independent, third-party profile of Pleo external-vendors API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.