Endpoint Templates

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.

• endpointTemplate

• endpointTemplate_count

• endpointTemplateExists

• fieldTag

• fieldTag_count

• fieldTagExists

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.

• field_path

• field_tag_id

• endpoint_template_id

Available Sorts

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

• field_path

• field_tag_id

• endpoint_template_id

Authorizations

ApiKeyAuth

Path parameters

endpoint_templatestringRequired

The endpoint template identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[entity_type_id]stringOptional

Filter results by entity_type_id.

filter[store_as]stringOptional

Filter results by store_as.

filter[is_required]stringOptional

Filter results by is_required.

includestringOptional

Comma-separated list of relationships to include. Available: entityType

sortstringOptional

Sort field. Prefix with - for descending. Available: name, entity_type_id, store_as, is_required

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/patchworks/endpoint-templates/{endpoint_template}/field-tags

HTTPcURLJavaScriptPython

GET /api/v1/patchworks/endpoint-templates/{endpoint_template}/field-tags HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "label": "My Label",
      "colour": "blue",
      "logo_url": "example_logo_url",
      "version": 1,
      "version_name": "example_version_name",
      "rate_limit_unit": "second",
      "rate_limit_duration": 1,
      "system_type_id": 1,
      "protocol": "HTTP",
      "company_id": 1,
      "date_format": "example_date_format",
      "help_link": "example_help_link",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/patchworks/endpoint-templates/{endpoint_template}/field-tags",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/patchworks/endpoint-templates/{endpoint_template}/field-tags?page=1",
    "last": "https://api.example.com/api/v1/patchworks/endpoint-templates/{endpoint_template}/field-tags?page=1",
    "prev": null,
    "next": null
  }
}