Labels

List Labels

get

Retrieves a paginated list of labels. Can be filtered by name.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

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

GET /api/v1/labels HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
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
  }
}

Create Label

post

Creates a new label.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Body

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

POST /api/v1/labels HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
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"
  }
}

Get Label

get

Retrieves the details of a specific label.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

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}

GET /api/v1/labels/{label} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
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 Label

put

Updates an existing label.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

labelstringRequired

The label identifier.

Body

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}

PUT /api/v1/labels/{label} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
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"
  }
}

Delete Label

delete

Permanently deletes a specific label.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

labelstringRequired

The label identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete/api/v1/labels/{label}

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

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