API introduction

The Inboundr REST API is a small JSON API. Every endpoint is authenticated with a bearer token, returns JSON and uses standard HTTP status codes.

Base URL#

https://inboundr.net/api/v1

Conventions#

• Requests: send JSON with Content-Type: application/json.
• Authentication: every request needs an Authorization: Bearer inb_… header. See Authentication.
• Responses: always JSON. List endpoints wrap results in { "data": [...] }, and paginated lists also include nextCursor.
• Errors: responses outside the 2xx range include an error field. See Errors.
• Timestamps: ISO 8601 strings in UTC, such as 2026-07-20T10:30:00.000Z.

Object IDs#

Each ID starts with a prefix for its type, so you can tell what it refers to:

Resources#