Dashly Docs

Products

`/products`

List products

GET
/products

One page of records, newest first unless you say otherwise, with the total count in meta so you know how far to paginate.

Required scope: products:read.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Query Parameters

page?integer

1-based. meta.totalPages says how many there are.

Range1 <= value
Default1
per_page?integer

Rows per page. A value above 200 returns 400 - never a silent clamp.

Range1 <= value <= 200
Default50
sort?string

Prefix with - for descending. An undeclared sort returns 400.

Default"name"
Value in"name""-name""createdAt""-createdAt""unitAmountCents""-unitAmountCents"
q?string

Case-insensitive "contains", across: name, description.

filter[kind]?string

Exact match on kind.

Value in"one_shot""recurring"
filter[active]?string

Exact match on active.

Value in"true""false"
filter[currency]?string

Exact match on currency.

Response Body

The requested page.

application/json
  1. response
data*array<>
meta*
Example Request
curl -X GET 'https://api.usedashly.com/v1/products'
Example Response
{  "data": [    {      "id": "string",      "name": "string",      "description": "string",      "descriptionHtml": "string",      "unitAmountCents": 0,      "currency": "string",      "reference": "string",      "designation": "string",      "nature": "service",      "unit": "none",      "defaultQuantity": "string",      "pricingMode": "fixed",      "taxRateBps": 0,      "taxRatePct": "string",      "kind": "one_shot",      "active": true,      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "perPage": 0,    "total": 0,    "totalPages": 0  }}

Create a product

POST
/products

Links are given as the target's public id (clientId: "hsbftmp3f5"); the API resolves them server-side. Fields the database requires but the interface decides for you are filled in the same way here.

Required scope: products:write.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Header Parameters

Idempotency-Key?string

A value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.

Length8 <= length <= 255

Request Body

application/json
  1. body
name*string
Length1 <= length <= 200
description?string
Lengthlength <= 2000
unitAmountCents?integer
Range0 <= value <= 999999900
currency?string
Length3 <= length <= 3
reference?string
Lengthlength <= 60
designation?string
Lengthlength <= 200
descriptionHtml?string
Lengthlength <= 20000
nature?string
Value in"service""goods"
unit?string
Value in"none""hour""day""month""percent""kg""m""m2""m3""ton""mg""flat_rate"
defaultQuantity?number
Range0 <= value <= 100000
pricingMode?string
Value in"fixed""on_quote"
taxRateBps?integer
Range0 <= value <= 10000
taxRatePct?number
Range0 <= value <= 100
kind?string
Value in"one_shot""recurring"
active?boolean
createdAt?string

When this actually happened, for an import. Past dates only; defaults to now. updatedAt follows it unless the body sets one.

Formatdate-time

Response Body

Created. The body is the new record, as a read would return it.

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.usedashly.com/v1/products' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
{  "data": {    "id": "string",    "name": "string",    "description": "string",    "descriptionHtml": "string",    "unitAmountCents": 0,    "currency": "string",    "reference": "string",    "designation": "string",    "nature": "service",    "unit": "none",    "defaultQuantity": "string",    "pricingMode": "fixed",    "taxRateBps": 0,    "taxRatePct": "string",    "kind": "one_shot",    "active": true,    "createdAt": "2019-08-24T14:15:22Z"  }}

Retrieve a product

GET
/products/{id}

The full record, custom fields included when the resource carries them. A record from another agency is a 404, not a 403 - its existence is not ours to confirm.

Required scope: products:read.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Path Parameters

id*string

The record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.

Response Body

Found.

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.usedashly.com/v1/products/string'
Example Response
{  "data": {    "id": "string",    "name": "string",    "description": "string",    "descriptionHtml": "string",    "unitAmountCents": 0,    "currency": "string",    "reference": "string",    "designation": "string",    "nature": "service",    "unit": "none",    "defaultQuantity": "string",    "pricingMode": "fixed",    "taxRateBps": 0,    "taxRatePct": "string",    "kind": "one_shot",    "active": true,    "createdAt": "2019-08-24T14:15:22Z"  }}

Update a product

PATCH
/products/{id}

A partial update: only the fields you send change. One exception - customFields is replaced wholesale, not merged, so sending it with a single key clears the others. Read the record, merge, then write.

Required scope: products:write.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Path Parameters

id*string

The record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.

Request Body

application/json
  1. body
name?string
Length1 <= length <= 200
description?string
Lengthlength <= 2000
unitAmountCents?integer
Range0 <= value <= 999999900
currency?string
Length3 <= length <= 3
reference?string
Lengthlength <= 60
designation?string
Lengthlength <= 200
descriptionHtml?string
Lengthlength <= 20000
nature?string
Value in"service""goods"
unit?string
Value in"none""hour""day""month""percent""kg""m""m2""m3""ton""mg""flat_rate"
defaultQuantity?number
Range0 <= value <= 100000
pricingMode?string
Value in"fixed""on_quote"
taxRateBps?integer
Range0 <= value <= 10000
taxRatePct?number
Range0 <= value <= 100
kind?string
Value in"one_shot""recurring"
active?boolean

Response Body

Updated. The body is the record as it now stands.

application/json
  1. response
data*
Example Request
curl -X PATCH 'https://api.usedashly.com/v1/products/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "id": "string",    "name": "string",    "description": "string",    "descriptionHtml": "string",    "unitAmountCents": 0,    "currency": "string",    "reference": "string",    "designation": "string",    "nature": "service",    "unit": "none",    "defaultQuantity": "string",    "pricingMode": "fixed",    "taxRateBps": 0,    "taxRatePct": "string",    "kind": "one_shot",    "active": true,    "createdAt": "2019-08-24T14:15:22Z"  }}

Delete a product

DELETE
/products/{id}

Permanent. The audit log keeps the trace; the record does not come back.

Required scope: products:write.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Path Parameters

id*string

The record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.

Response Body

Deleted. Empty body.

Example Request
curl -X DELETE 'https://api.usedashly.com/v1/products/string'
Example Response
Empty

List available actions

GET
/products/actions

Every verb this resource answers to, with its target and the JSON Schema of its body - the same contracts this document describes, readable at runtime.

Required scope: products:read.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Response Body

The available verbs.

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://api.usedashly.com/v1/products/actions'
Example Response
{  "data": [    {      "name": "string",      "label": "string",      "description": "string",      "target": "item",      "readOnly": true,      "path": "string",      "input": {}    }  ]}

Product packages

`/product-packages`

Project cycles

`/project-cycles` - read-only