Skip to content

List items

Request

Retrieve a paginated list of items (services and supplies) for the account.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

Query
activeboolean

Filter by active status

typestring(?i)SERVICE|SUPPLY

Filter by item type

Enum:"SERVICE""SUPPLY"
taxableboolean

Filter by taxable status

categoryIdinteger, (int64)

Filter by category ID

sortBystring(?i)NAME|CREATED_DATE

Sort by field

Default:"NAME"
Enum:"NAME""CREATED_DATE"
sortDirstring(?i)ASC|DESC

Sort direction

Default:"ASC"
Enum:"ASC""DESC"
cursorstring, [ 0 .. 2048 ] characters

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20
Example:limit=20
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/item?active=true&type=SERVICE&taxable=true&categoryId=0&sortBy=NAME&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Items retrieved successfully

Bodyapplication/json
itemsArray of objects(ItemDTO)

List of items

nextCursorstring

Opaque cursor for fetching the next page. Null if no more results.

Response
{
  "items": [
    { … }
  ],
  "nextCursor": "string"
}