Browse the docs

List services

GET/api/v1/services

Needs an API key, and runs with the access of the member who made the key.
A connected AI assistant can use it too, as listServices.

Parameters

In the query string

pageinteger
Default: 1. At least 1.
per_pageinteger
Default: 50. At least 1. At most 100.
include_inactiveboolean
Default: false.

Responses

200Paginated services.

dataarray of objectrequired
Each item(12)
- lock_versioninteger
  At least 0.
- created_atstring (date-time)required
- updated_atstring (date-time)required
- idstring (uuid)required
- account_idstring (uuid)required
- namestringrequired
- descriptionstring or null
- unit_namestringrequired
- unit_price_centsinteger (int64)required
  Integer minor currency units, such as pence.
  At least 0.
- tax_rate_basis_pointsintegerrequired
  At least 0. At most 10000.
- tax_inclusivebooleanrequired
- activebooleanrequired
metaobjectrequired
Fields(4)
- pageintegerrequired
  At least 1.
- per_pageintegerrequired
  At least 1. At most 100.
- totalintegerrequired
  At least 0.
- total_pagesintegerrequired
  At least 0.

A refusal answers in the one error shape every operation shares.

Example

A request our own tests send. The ids are made up: put your own in their place.

curl "https://app.tradesender.co.uk/api/v1/services?page=1&per_page=50&include_inactive=false" \
  -H "Authorization: Bearer $TRADESENDER_KEY"