GET
/
items
curl --request GET \
  --url https://api.withorb.com/v1/items \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "external_connections": [
        {
          "external_connection_name": "stripe",
          "external_entity_id": "<string>"
        }
      ]
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Query Parameters

​
limit
integer
default:
20

The number of items to fetch. Defaults to 20.

Required range: 1 < x < 100
​
cursor
string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

Response

200
application/json
OK
​
data
object[]
required

The Item resource represents a sellable product or good. Items are associated with all line items, billable metrics, and prices and are used for defining external sync behavior for invoices and tax calculation purposes.

​
pagination_metadata
object
required

Was this page helpful?

Void invoiceCreate item