TAtalon
Roles

Get role

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Get the details of a specific role. To see all the roles, use the List roles endpoint.

get/v2/roles/{roleId}

Request

Path parameters

roleIdinteger required

The ID of role.

Note: To find the ID of a role, use the List roles endpoint.

Response

OK

idinteger required

The internal ID of this entity.

createdstring date-time required

The time this entity was created.

modifiedstring date-time required

The time this entity was last modified.

accountIdinteger required

The ID of the account that owns this entity.

namestring

Name of the role.

descriptionstring

Description of the role.

membersinteger[]

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. This property cannot be set for new or existing roles. It is reserved for predefined roles, such as the Talon.One support role.

Example response

{
  "id": 6,
  "created": "2020-06-10T09:05:27.993483Z",
  "modified": "2021-09-12T10:12:42Z",
  "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": {
      "applications": {
        "1": {
          "application": "Application permission set"
        },
        "3": {
          "campaign": "Campaign manager permission set"
        },
        "4": {
          "draftCampaign": "Campaign read-only permission set"
        },
        "5": {
          "tools": "Tools permission set"
        }
      },
      "loyaltyPrograms": {
        "10": "Loyalty program manager permission set"
      },
      "campaignAccessGroups": {
        "5": "Campaign access group manager permission set"
      },
      "account": "Account administration permission set"
    },
    "thresholds": [
      {
        "loyaltyProgramId": 8,
        "loyaltyPointsLimit": 100
      }
    ]
  },
  "members": [
    10,
    12
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.