Labels

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

• name

• name_count

• nameExists

• colour

• colour_count

• colourExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

• name

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

• created_at

Authorizations

ApiKeyAuth

Query parameters

filter[name]stringOptional

Filter results by name.

includestringOptional

Comma-separated list of relationships to include. Available: name, colour

sortstringOptional

Sort field. Prefix with - for descending. Available: created_at

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/labels

HTTPcURLJavaScriptPython

GET /api/v1/labels HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "colour": "blue",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "name": "My Example"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/labels",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/labels?page=1",
    "last": "https://api.example.com/api/v1/labels?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
name	string	☑
colour		☑

Authorizations

ApiKeyAuth

Body

application/json

colourstring · enumRequiredPossible values:

namestring · max: 20Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/labels

HTTPcURLJavaScriptPython

POST /api/v1/labels HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "colour": "blue",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "colour": "blue",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example"
  }
}

Show

get

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

• name

• name_count

• nameExists

• colour

• colour_count

• colourExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

• name

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

• created_at

Authorizations

ApiKeyAuth

Path parameters

labelstringRequired

The label identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

includestringOptional

Comma-separated list of relationships to include. Available: name, colour

sortstringOptional

Sort field. Prefix with - for descending. Available: created_at

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/labels/{label}

HTTPcURLJavaScriptPython

GET /api/v1/labels/{label} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "colour": "blue",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example"
  }
}

Update

put

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
name	string
colour

Authorizations

ApiKeyAuth

Path parameters

labelstringRequired

The label identifier.

Body

application/json

colourstring · enumOptionalPossible values:

namestring · max: 20Optional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/labels/{label}

HTTPcURLJavaScriptPython

PUT /api/v1/labels/{label} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "colour": "blue",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "colour": "blue",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example"
  }
}

Destroy

delete

Delete a label.

Authorizations

ApiKeyAuth

Path parameters

labelstringRequired

The label identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/labels/{label}

HTTPcURLJavaScriptPython

DELETE /api/v1/labels/{label} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "message": "Action completed successfully."
}