Retainers
`/forfaits`
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: forfaits:read.
bearerAuthAuthorizationBearer <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.
page?integer1-based. meta.totalPages says how many there are.
1 <= value1per_page?integerRows per page. A value above 200 returns 400 - never a silent clamp.
1 <= value <= 20050sort?stringPrefix with - for descending. An undeclared sort returns 400.
"-createdAt""createdAt""-createdAt""periodStart""-periodStart"filter[type]?stringExact match on type.
"monthly""project""quarterly""semiannual""annual"filter[clientId]?stringExact match on clientId.
The requested page.
application/json- response
data*array<>meta*curl -X GET 'https://api.usedashly.com/v1/forfaits'{ "data": [ { "id": "string", "clientId": "string", "type": "monthly", "amountMinutes": 0, "rollsOver": true, "periodStart": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" } ], "meta": { "page": 0, "perPage": 0, "total": 0, "totalPages": 0 }}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: forfaits:write.
bearerAuthAuthorizationBearer <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.
Idempotency-Key?stringA 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.
8 <= length <= 255application/json- body
amountMinutes*integer0 <= value <= 9007199254740991type?string"monthly""project"rollsOver?booleanperiodStart?string|nullclientId*stringprojectId?string|nullcreatedAt?stringWhen this actually happened, for an import. Past dates only; defaults to now. updatedAt follows it unless the body sets one.
date-timeCreated. The body is the new record, as a read would return it.
application/json- response
data*curl -X POST 'https://api.usedashly.com/v1/forfaits' \ -H 'Content-Type: application/json' \ -d '{ "amountMinutes": 0, "clientId": "string"}'{ "data": { "id": "string", "clientId": "string", "type": "monthly", "amountMinutes": 0, "rollsOver": true, "periodStart": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" }}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: forfaits:read.
bearerAuthAuthorizationBearer <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.
id*stringThe record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.
Found.
application/json- response
data*curl -X GET 'https://api.usedashly.com/v1/forfaits/string'{ "data": { "id": "string", "clientId": "string", "type": "monthly", "amountMinutes": 0, "rollsOver": true, "periodStart": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" }}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: forfaits:write.
bearerAuthAuthorizationBearer <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.
id*stringThe record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.
application/json- body
amountMinutes?integer0 <= value <= 9007199254740991type?string"monthly""project"rollsOver?booleanperiodStart?string|nullclientId?stringprojectId?string|nullUpdated. The body is the record as it now stands.
application/json- response
data*curl -X PATCH 'https://api.usedashly.com/v1/forfaits/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": { "id": "string", "clientId": "string", "type": "monthly", "amountMinutes": 0, "rollsOver": true, "periodStart": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" }}Permanent. The audit log keeps the trace; the record does not come back.
Required scope: forfaits:write.
bearerAuthAuthorizationBearer <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.
id*stringThe record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.
Deleted. Empty body.
curl -X DELETE 'https://api.usedashly.com/v1/forfaits/string'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: forfaits:read.
bearerAuthAuthorizationBearer <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.
The available verbs.
application/json- response
data*array<>curl -X GET 'https://api.usedashly.com/v1/forfaits/actions'{ "data": [ { "name": "string", "label": "string", "description": "string", "target": "item", "readOnly": true, "path": "string", "input": {} } ]}