Skip to main content
GET
/
tags
/
v2
/
rs
/
{tagId}
Get tag
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/tags/v2/rs/{tagId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "id": 1,
  "name": "brands",
  "type": 1,
  "organizationId": 42,
  "createdAt": "2024-12-01T12:34:56.000Z",
  "updatedAt": "2024-12-05T14:56:23.000Z",
  "tags": [
    {
      "id": 1,
      "name": "at the office",
      "color": "#FF5733",
      "createdAt": "2024-12-01T12:34:56.000Z",
      "updatedAt": "2024-12-05T14:56:23.000Z"
    }
  ],
  "countSites": 5,
  "updatableFields": {
    "name": true,
    "selectionMode": true,
    "tags": true
  },
  "actions": {
    "canBeUpdated": true,
    "canBeDeleted": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Path Parameters

​
tagId
integer
required

Unique identifier of the tag.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "tags": Get the tags of the tag type

  • "count-sites": Get the site amount

  • "updatable-fields": Get information about the field that can be updated

  • "actions-info": Give information about the origin of the tagType (commission or intervention)

Available options:
tags,
count-sites,
updatable-fields,
actions-info

Response

204 - application/json
object | null

Information about the tag

​
id
integer
required

Unique identifier of the tag type.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
name
string
required

Name of the tag type (e.g., 'brands').

Maximum string length: 250
Example:

"brands"

​
type
enum<number>
required

Tag type (e.g., simple, multiple).

Available options:
1,
2,
1,
2
Example:

1

​
organizationId
integer
required

Identifier of the associated organization.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

42

​
createdAt
required

Creation date of the tag type.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-12-01T12:34:56.000Z"

​
updatedAt
required

Date of the last update of the tag type.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-12-05T14:56:23.000Z"

​
tags
object[]
​
countSites
integer

Number of sites associated with the tag.

Required range: 0 <= x <= 9007199254740991
Example:

5

​
updatableFields
object
​
actions
object