Skip to main content

Getting started with the API

Use the Zenvio API to read or manage business records in an authorized organization. Start with a read request before building a workflow that creates or changes records.

Prepare access​

You need the organization identifier and a credential with permission to read the resource you want to inspect. See Authentication for bearer credentials and organization API-key access.

Build the request URL​

The integration API uses this base URL:

https://api.zenvio.com/v1/org/{orgId}

Replace {orgId} with your permanent organization ID. Add the path shown by an endpoint in the reference. For organization 123, the invoice list is:

https://api.zenvio.com/v1/org/123/sales/invoices

Selecting an organization does not grant permission to its records. Your credential must be authorized for that organization and operation.

Make a first read request​

The following example reads at most one invoice. The credential comes from an environment variable; replace the organization ID with your own.

curl --request GET \
  'https://api.zenvio.com/v1/org/123/sales/invoices?from=0&take=1' \
  --header "Authorization: Bearer $ZENVIO_API_KEY" \
  --header 'Accept: application/json'

Review the status code and response before proceeding. An empty result can be valid when the organization has no matching invoices. Use the endpoint page for its exact query parameters and response schema.

Find a resource​

The API Reference section lists modules and resources alphabetically, derived from their URL paths. For example, open Sales / Invoices, then choose an operation for parameters, request bodies and responses.

For writes, check the required fields and permissions first. A successful save can precede accounting processing; review the relevant record state before assuming the ledger and reports are ready.