/
Retrieve a tag

Retrieve a tag

Request

Retrieves a tag with a specified name.

Security
SecretApiKey or JWT
Path
tagstring^[@~\-\.\w\s+]+$required

Name of the tag.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/tags/{tag}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Tag with a specified name retrieved.

Bodyapplication/json
idstring, <= 50 characters(ResourceId)read-only

ID of the tag.

Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
namestring, <= 255 characters^[@~\-\.\w\s+]+$required

Unique name for the tag. Tag names are not case-sensitive.

Example:"New"
typestringrequired

Type of tag. Tags of a specific type can only be assigned to corresponding entity types. For example, you can only use customer tags on customers.

Enum:"customer""kyc-document""aml-check"
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

Response
{
  "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  "name": "New",
  "type": "customer",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}