Developer docs
/
Rebilly API
/
Tags
/
Retrieve a tag

Retrieve a tag

Retrieves a tag with a specified name.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
tag
required
string^[@~\-\.\w\s]+$

Name of the tag.

get
/tags/{tag}
Responses

200

Tag with a specified name retrieved.

Response Schema: application/json
id
string (ResourceId) <= 50 characters

Unique resource ID.

name
required
string <= 255 characters ^[@~\-\.\w\s]+$

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

type
required
string

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"
createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

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

]
}