Project templates

List project templates

GET

/project-templates

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: project-templates: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"-createdAt"

Value in"createdAt""-createdAt""name""-name"

q?string

Case-insensitive "contains", across: name.

Response Body

The requested page.

application/json

response

data*array<>

meta*

Example Request

curl -X GET 'https://api.usedashly.com/v1/project-templates'

Example Request

curl -X GET 'https://api.usedashly.com/v1/project-templates'

Example ResponseSchema

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "page": 0,
    "perPage": 0,
    "total": 0,
    "totalPages": 0
  }
}

{  "data": [    {      "id": "string",      "name": "string",      "description": "string",      "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: project-templates: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

Request Body

application/json

body

name*string

Length2 <= length <= 120

description?|null

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

response

data*

Example Request

curl -X POST 'https://api.usedashly.com/v1/project-templates' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'

Example Request

curl -X POST 'https://api.usedashly.com/v1/project-templates' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'

Example ResponseSchema

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{  "data": {    "id": "string",    "name": "string",    "description": "string",    "createdAt": "2019-08-24T14:15:22Z"  }}

Retrieve a project template

GET

/project-templates/{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: project-templates: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

response

data*

Example Request

curl -X GET 'https://api.usedashly.com/v1/project-templates/string'

Example Request

curl -X GET 'https://api.usedashly.com/v1/project-templates/string'

Example ResponseSchema

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{  "data": {    "id": "string",    "name": "string",    "description": "string",    "createdAt": "2019-08-24T14:15:22Z"  }}

Update a project template

PATCH

/project-templates/{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: project-templates: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

body

name?string

Length2 <= length <= 120

description?|null

Response Body

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

application/json

response

data*

Example Request

curl -X PATCH 'https://api.usedashly.com/v1/project-templates/string' \
  -H 'Content-Type: application/json' \
  -d '{}'

Example Request

curl -X PATCH 'https://api.usedashly.com/v1/project-templates/string' \  -H 'Content-Type: application/json' \  -d '{}'

Example ResponseSchema

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{  "data": {    "id": "string",    "name": "string",    "description": "string",    "createdAt": "2019-08-24T14:15:22Z"  }}

Delete a project template

DELETE

/project-templates/{id}

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

Required scope: project-templates: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/project-templates/string'

Example Request

curl -X DELETE 'https://api.usedashly.com/v1/project-templates/string'

Example Response

Empty

List available actions

GET

/project-templates/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: project-templates: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

response

data*array<>

Example Request

curl -X GET 'https://api.usedashly.com/v1/project-templates/actions'

Example Request

curl -X GET 'https://api.usedashly.com/v1/project-templates/actions'

Example ResponseSchema

{
  "data": [
    {
      "name": "string",
      "label": "string",
      "description": "string",
      "target": "item",
      "readOnly": true,
      "path": "string",
      "input": {}
    }
  ]
}

{  "data": [    {      "name": "string",      "label": "string",      "description": "string",      "target": "item",      "readOnly": true,      "path": "string",      "input": {}    }  ]}

Create a project from this template

POST

/project-templates/{id}/actions/instantiate

Creates a project called name - attached to clientId when given - plus one ticket per template item. The project type (client onboarding) stays dashboard-only: the client notifications do not exist on the API side yet.

Does what the dashboard's createProjectFromTemplateAction does - same implementation, so the two cannot diverge.

Required scope: project-templates: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 public id of the record to act on. It is resolved inside your agency before the action runs, so an id from another tenant is a 404 and never reaches it.

Header Parameters

Request Body

application/json

body

name*string

Length2 <= length <= 120

clientId?string

Length1 <= length <= 60

Response Body

Done.

application/json

response

data*unknown

The action's result; its shape depends on the verb.

Example Request

curl -X POST 'https://api.usedashly.com/v1/project-templates/string/actions/instantiate' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'

Example Request

curl -X POST 'https://api.usedashly.com/v1/project-templates/string/actions/instantiate' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'

Example ResponseSchema

{
  "data": null
}

{  "data": null}

Add an item to the template

POST

/project-templates/{id}/actions/add-item

Appends a template ticket to the template - title, scope, priority, category by its public id, client visibility - and returns its position.

Does what the dashboard's addProjectTemplateItemAction does - same implementation, so the two cannot diverge.

Required scope: project-templates: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 public id of the record to act on. It is resolved inside your agency before the action runs, so an id from another tenant is a 404 and never reaches it.

Header Parameters

Request Body

application/json

body

title*string

Length2 <= length <= 160

scope?string

client or agency. internal is a deprecated alias of agency, stored as agency.

Value in"client""agency""internal"

priority?string

Default"medium"

Value in"low""medium""high""urgent"

categoryId?string

Length1 <= length <= 60

clientVisible?boolean

Defaultfalse

Response Body

Done.

application/json

response

data*unknown

The action's result; its shape depends on the verb.

Example Request

curl -X POST 'https://api.usedashly.com/v1/project-templates/string/actions/add-item' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string"
}'

Example Request

curl -X POST 'https://api.usedashly.com/v1/project-templates/string/actions/add-item' \  -H 'Content-Type: application/json' \  -d '{  "title": "string"}'

Example ResponseSchema

{
  "data": null
}

{  "data": null}

Remove an item from the template

POST

/project-templates/{id}/actions/remove-item

Removes the template ticket with exactly this title - the first in template order when several share it. Items carry no public id, so the title is their address. Projects already created from the template keep their tickets.

Does what the dashboard's deleteProjectTemplateItemAction does - same implementation, so the two cannot diverge.

Required scope: project-templates: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.

body

title*string

Length1 <= length <= 160

Response Body

Done.

application/json

response

data*unknown

The action's result; its shape depends on the verb.

Example Request

curl -X POST 'https://api.usedashly.com/v1/project-templates/string/actions/remove-item' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string"
}'

Example Request

curl -X POST 'https://api.usedashly.com/v1/project-templates/string/actions/remove-item' \  -H 'Content-Type: application/json' \  -d '{  "title": "string"}'

Example ResponseSchema

{
  "data": null
}

{  "data": null}

List project templatesCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Create a project templateCopy Anchor Link

AuthorizationCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Retrieve a project templateCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Update a project templateCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Delete a project templateCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

List available actionsCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Create a project from this templateCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Add an item to the templateCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Remove an item from the templateCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

List project templates

Authorization

Query Parameters

Response Body

Create a project template

Authorization

Header Parameters

Request Body

Response Body

Retrieve a project template

Authorization

Path Parameters

Response Body

Update a project template

Authorization

Path Parameters

Request Body

Response Body

Delete a project template

Authorization

Path Parameters

Response Body

List available actions

Authorization

Response Body

Create a project from this template

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

Add an item to the template

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

Remove an item from the template

Authorization

Path Parameters

Header Parameters

Request Body

Response Body