younifyd
Menu

Get Role V2

Get role

GET/v2/roles/{roleId}

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Get Role V2 action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{getRoleV2.response.data}}.

Request

Path parameters

roleIdinteger (int64)required

The ID of role. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.

Response

Returns 200 with an object. Read it in later steps with {{getRoleV2.response.data.<field>}}.

idinteger (int64)

The internal ID of this entity.

createdstring (date-time)

The time this entity was created.

modifiedstring (date-time)

The time this entity was last modified.

accountIdinteger (int64)

The ID of the account that owns this entity.

namestring

Name of the role.

descriptionstring

Description of the role.

permissionsobject
permissionSetsarray<object>2 fields

List of grouped logical operations referenced by roles.

rolesobject4 fields
membersarray<integer (int64)>

A list of user IDs the role is assigned to.

isReadonlyboolean

Identifies if the role is read-only. For read-only roles, you can only assign or unassign users. You cannot edit any other properties, such as the name, description, or permissions. The 'isReadonly' property cannot be set for new or existing roles. It is reserved for predefined roles, such as the Talon.One support role.

Default false

json
{
  "id": 6,
  "created": {},
  "modified": {},
  "accountId": 3886,
  "name": "Campaign and campaign access group manager",
  "description": "Allows you to create and edit campaigns for specific Applications, delete specific campaign access groups, and view loyalty programs.",
  "permissions": {
    "permissionSets": [
      {
        "name": "Application permission set",
        "logicalOperations": [
          "getApplicationOperations",
          "editApplicationOperations"
        ]
      },
      {
        "name": "Campaign manager permission set",
        "logicalOperations": [
          "getCampaignOperations",
          "createCampaignOperations",
          "updateCampaignOperations"
        ]
      },
      {
        "name": "Campaign read-only permission set",
        "logicalOperations": [
          "getCampaignOperations"
        ]
      },
      {
        "name": "Loyalty program read-only permission set",
        "logicalOperations": [
          "getLoyaltyProgramOperations"
        ]
      },
      {
        "name": "Campaign access group manager permission set",
        "logicalOperations": [
          "getCampaignAccessGroupOperations",
          "updateCampaignAccessGroupOperations",
          "deleteCampaignAccessGroupOperations"
        ]
      }
    ],
    "roles": {
      "campaignAccessGroups": {
        "5": "Campaign access group manager permission set"
      },
      "loyaltyPrograms": {
        "10": "Loyalty program manager permission set"
      },
      "account": "account",
      "applications": {
        "1": {
          "application": "Application permission set"
        },
        "3": {
          "campaign": "Campaign manager permission set"
        },
        "4": {
          "draftCampaign": "Campaign read-only permission set"
        },
        "5": {
          "tools": "Tools permission set"
        }
      }
    }
  },
  "members": [
    10,
    12
  ],
  "isReadonly": false
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.