Get resource types

Gets a list of resource types.

get

Query parameters

CodestringOptional

Filter by code.

NamestringOptional

Filter by name.

TagsstringOptional

Filter by tags.

DescriptionstringOptional

Filter by description.

Typestring · enumOptional

The param type to apply filter.

Possible values:

KeywordsstringOptional

Filter by keywords.

api-versionstringOptional

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

AuthkeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required AuthKey header.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/resource-types HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "parentBrandId": null,
      "guid": null,
      "code": "USER",
      "name": "User",
      "description": "The user resource",
      "tags": "ResourceType Tags",
      "type": "BuiltIn",
      "id": "sApKpllz4sAplsmzha"
    }
  ],
  "errors": []
}