Custom statuses

Custom statuses let you refine the statuses of jobs, outsourced jobs, quotes, invoices and purchase orders. A custom status always belongs to one of the existing statuses, its parent status. For example, you can add a "Pending client approval" status under the "Not started" status of a job.

Custom statuses are available with a Plus, Premium or Team subscription. The endpoints on this page return the custom statuses defined in your account. To set a custom status on an entity, use its id as the customStatus parameter of the update endpoint of the entity: Jobs, Outsourcing, Quotes, Invoices or Purchase orders.

The custom status object

Properties

  • archivedboolean

    True if the custom status is archived. An archived custom status cannot be set anymore, but it stays on the entities that already use it.

  • colorstring

    The color of the custom status.

  • idstring

    The id of the custom status.

  • namestring

    The name of the custom status.

  • ordernumber

    The position of the custom status among the custom statuses of the same entity.

  • parentStatusnumber

    The status the custom status belongs to. It is one of the values of the status property of the entity: 1 to 6 for jobs and outsourced jobs, 1 to 4 for quotes and invoices, and 1 to 3 for purchase orders.

custom status object

{
  "id": "67a4c1f2e4b0a1b2c3d4e5f1",
  "name": "Pending client approval",
  "color": "#4f46e5",
  "parentStatus": 1,
  "archived": false,
  "order": 1
}
GET/v2/account/custom-statuses

List all custom statuses

This endpoint allows you to retrieve the custom statuses of all the entities, grouped by entity: jobs, outsourcings, quotes, invoices and purchaseOrders. The archived custom statuses are included. For each entity, the custom statuses are sorted by parent status and then by position.

Request

GET
/v2/account/custom-statuses
curl -G https://api.lsp.expert/v2/account/custom-statuses \
  -u {key}:

Response

{
  "jobs": [
    {
      "id": "67a4c1f2e4b0a1b2c3d4e5f1",
      "name": "Pending client approval",
      "color": "#4f46e5",
      "parentStatus": 1,
      "archived": false,
      "order": 1
    },
    {
      "id": "67a4c20ae4b0a1b2c3d4e5f2",
      "name": "Under review",
      "color": "#65a30d",
      "parentStatus": 2,
      "archived": false,
      "order": 2
    }
  ],
  "outsourcings": [],
  "quotes": [],
  "invoices": [],
  "purchaseOrders": []
}
GET/v2/account/custom-statuses/:type

List the custom statuses of an entity

This endpoint allows you to retrieve the custom statuses of one entity. The archived custom statuses are included. The custom statuses are sorted by parent status and then by position.

Path parameters

  • typestring Required

    The entity: jobs, outsourcings, quotes, invoices or purchase-orders.

Request

GET
/v2/account/custom-statuses/:type
curl -G https://api.lsp.expert/v2/account/custom-statuses/jobs \
  -u {key}:

Response

[
  {
    "id": "67a4c1f2e4b0a1b2c3d4e5f1",
    "name": "Pending client approval",
    "color": "#4f46e5",
    "parentStatus": 1,
    "archived": false,
    "order": 1
  },
  {
    "id": "67a4c20ae4b0a1b2c3d4e5f2",
    "name": "Under review",
    "color": "#65a30d",
    "parentStatus": 2,
    "archived": false,
    "order": 2
  }
]