Tags

Part of the Sales API. Base URL https://your-domain.com/admin/api/v1 — replace the host with your own installation and the token placeholder with a real Bearer token (see Authentication).

GET /admin/api/v1/sales/tags

Retrieve a paginated list of sales tags with filtering and sorting

🔒 Requires a valid Bearer token.

Query parameters

Parameter	Type	Required	Description	Example
`include`	string	No	Comma-separated list of relationships to include. Available options: creator	`creator`
`filter[id]`	string	No	Comma-separated list of IDs to filter by
`filter[name]`	string	No	Filter by tag name (partial match)
`sort`	string	Yes	Sort field	`name`
`page`	integer	Yes	Page number	`1`

cURLJavaScriptPHPPython

bash

curl -X GET "https://your-domain.com/admin/api/v1/sales/tags?include=creator&sort=name&page=1" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/sales/tags?include=creator&sort=name&page=1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/sales/tags?include=creator&sort=name&page=1', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/sales/tags?include=creator&sort=name&page=1"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": [
    {
      "id": null,
      "name": "adipisci quidem",
      "color": "#4137f1",
      "creator_id": 1,
      "created_at": null,
      "updated_at": null
    },
    {
      "id": null,
      "name": "qui commodi",
      "color": "#bd6da5",
      "creator_id": 1,
      "created_at": null,
      "updated_at": null
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "page": null,
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "page": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "page": null,
        "active": false
      }
    ],
    "path": "/",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Create tag

POST /admin/api/v1/sales/tags

Create a new sales tag

🔒 Requires a valid Bearer token.

Body parameters

Parameter	Type	Required	Description
`name`	string	Yes	Sales tag name (max 255 characters). Must not be greater than 255 characters.
`color`	string	No	Tag color in hex format (max 7 characters). Must not be greater than 7 characters.

cURLJavaScriptPHPPython

bash

curl -X POST "https://your-domain.com/admin/api/v1/sales/tags" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Urgent",
  "color": "#FF5733"
}'

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/sales/tags", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "name": "Urgent",
  "color": "#FF5733"
}),
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/sales/tags', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
    'name' => 'Urgent',
    'color' => '#FF5733',
  ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/sales/tags"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

payload = {
    "name": "Urgent",
    "color": "#FF5733",
}

response = requests.post(url, headers=headers, json=payload)

data = response.json()
print(data)

Example response 201

json

{
  "data": {
    "id": null,
    "name": "eius et",
    "color": "#076b61",
    "creator_id": 1,
    "created_at": null,
    "updated_at": null
  },
  "message": "Tag created successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Show tag

GET /admin/api/v1/sales/tags/{id}

Retrieve a specific sales tag by its ID

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The tag ID

Query parameters

Parameter	Type	Required	Description	Example
`include`	string	No	Comma-separated list of relationships to include. Available options: creator	`creator`

cURLJavaScriptPHPPython

bash

curl -X GET "https://your-domain.com/admin/api/v1/sales/tags/{id}?include=creator" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/sales/tags/{id}?include=creator", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/sales/tags/{id}?include=creator', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/sales/tags/{id}?include=creator"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": null,
    "name": "adipisci quidem",
    "color": "#4137f1",
    "creator_id": 1,
    "created_at": null,
    "updated_at": null
  }
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Update tag

PUT /admin/api/v1/sales/tags/{id}

Update an existing sales tag

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The tag ID

Body parameters

Parameter	Type	Required	Description
`name`	string	No	Sales tag name (max 255 characters). Must not be greater than 255 characters.
`color`	string	No	Tag color in hex format (max 7 characters). Must not be greater than 7 characters.

cURLJavaScriptPHPPython

bash

curl -X PUT "https://your-domain.com/admin/api/v1/sales/tags/{id}" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Urgent",
  "color": "#FF5733"
}'

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/sales/tags/{id}", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "name": "Urgent",
  "color": "#FF5733"
}),
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-domain.com/admin/api/v1/sales/tags/{id}', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
    'name' => 'Urgent',
    'color' => '#FF5733',
  ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/sales/tags/{id}"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

payload = {
    "name": "Urgent",
    "color": "#FF5733",
}

response = requests.put(url, headers=headers, json=payload)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": null,
    "name": "eius et",
    "color": "#076b61",
    "creator_id": 1,
    "created_at": null,
    "updated_at": null
  },
  "message": "Tag updated successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Delete tag

DELETE /admin/api/v1/sales/tags/{id}

Delete a sales tag

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`id`	integer	Yes	The tag ID

cURLJavaScriptPHPPython

bash

curl -X DELETE "https://your-domain.com/admin/api/v1/sales/tags/{id}" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/sales/tags/{id}", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-domain.com/admin/api/v1/sales/tags/{id}', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/sales/tags/{id}"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.delete(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "message": "Tag deleted successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Tags ​

List tags ​

Create tag ​

Show tag ​

Update tag ​

Delete tag ​

Tags

List tags

Create tag

Show tag

Update tag

Delete tag