Get a list of tags

Prev Next
Get
/v{version}/Tags

In addition to default tags, SOC tags are included. Only tags that have a parent are returned. Tags are implicitly filtered by the parent's read permission.

Security
API Key: api_key
Header parameter nameX-ApiKey

Api Key

API Key: session_id
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Query parameters
name
string

Name of the tag

parentName
string

Name of the parent tag

type
string

Type of tag

Valid values[ "Standard", "LiveTag", "SyncTag", "ConflictTag", "StartOfCommunication" ]
Responses
200

OK

Array of object
object

Tag

Created
string (date-time)

Creation date in UTC

Id
integer (int32)

Unique ID of the tag

Modified
string (date-time)

Modification date in UTC

Name
string

Name of the tag

Parent
object (V1.Models.Tag.ParentTag)

Parent tag

Id
integer (int32)

Unique ID of the parent tag

Name
string

Name of the parent tag

ParentId
integer (int32)

Unique ID of the parent tag

Permissions
object

Permissions of the tag

Read
boolean
Write
boolean
StartOfCommunication
string (date-time)

Start of communication date for SOC tag in UTC

Type
string

Tag types

Valid values[ "Standard", "LiveTag", "SyncTag", "ConflictTag", "StartOfCommunication" ]
400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
401

Unauthorized

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
403

Access denied

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties