Unit

• Allowed query parameters
• Create a unit
• Update a unit
• Retrieve a unit
• Delete a unit
• List units

Allowed query parameters

None

Create a unit

post

/unit

Attribute (* required)	Type	Description
name *	String	Short name (eg. l)
description	String?	Descriptive name (eg. liters)

Example response

// HTTP 201 Created
{
    // a unit object
}

Update a unit

put

/unit/{id}

Attribute (* required)	Type	Description
name	String	Short name (eg. l)
description	String?	Descriptive name (eg. liters)

Example response

// HTTP 200 OK
{
    // a unit object
}

Retrieve a unit

get

/unit/{id}

Example response

// HTTP 200 OK
{
	"id": "8y3AdBxwPL",
	"name": "l",
	"description": "Liter"
}

Delete a unit

delete

/unit/{id}

Example response

// HTTP 204 No Content

List units

get

/unit

The list endpoint accepts the same parameters as in Retrieve a unit and returns a paginated array of the same unit object in the data property.

Read more about Pagination, Filtering, Sorting and Includes on the Introduction page.