GET api/event/{id}/roles

Get the roles for an event by its Id Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The id of the role to get.

integer

Required

Body Parameters

None.

Response Information

Resource Description

The role or null if it does not exist

Collection of RoleDataContract
NameDescriptionTypeAdditional information
OwningTeamId

The unique identifier of the related owning team resource.

integer

None.

BranchId

The unique identifier of the related branch resource.

integer

None.

Name

The name value.

string

None.

TeamAccessType

The team access type value.

string

None.

RoleType

The role type value.

EnumDataContract

None.

RoleStatus

The role status value.

EnumDataContract

None.

CustomFields

The collection of custom fields.

Collection of CustomFieldGroupWithValuesDataContract

None.

CreatedDate

The created date, expressed as a date and time.

date

None.

CreatedBy

The created by value.

CreatedByDataContract

None.

Id

The unique identifier of this resource.

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "OwningTeamId": 1,
    "BranchId": 2,
    "Name": "sample string 3",
    "TeamAccessType": "sample string 4",
    "RoleType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "RoleStatus": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "CustomFields": [
      {
        "Name": "sample string 1",
        "Values": [
          {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 1",
            "Value": {}
          },
          {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 1",
            "Value": {}
          }
        ]
      },
      {
        "Name": "sample string 1",
        "Values": [
          {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 1",
            "Value": {}
          },
          {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 1",
            "Value": {}
          }
        ]
      }
    ],
    "CreatedDate": "2026-08-05T00:21:01.4991554Z",
    "CreatedBy": {
      "Initials": "sample string 1",
      "ContactName": "sample string 2",
      "Gender": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "PrimaryTelephone": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "PrimaryEmail": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "JobTitle": "sample string 6",
      "Id": 7
    },
    "Id": 6
  },
  {
    "OwningTeamId": 1,
    "BranchId": 2,
    "Name": "sample string 3",
    "TeamAccessType": "sample string 4",
    "RoleType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "RoleStatus": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "CustomFields": [
      {
        "Name": "sample string 1",
        "Values": [
          {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 1",
            "Value": {}
          },
          {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 1",
            "Value": {}
          }
        ]
      },
      {
        "Name": "sample string 1",
        "Values": [
          {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 1",
            "Value": {}
          },
          {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 1",
            "Value": {}
          }
        ]
      }
    ],
    "CreatedDate": "2026-08-05T00:21:01.4991554Z",
    "CreatedBy": {
      "Initials": "sample string 1",
      "ContactName": "sample string 2",
      "Gender": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "PrimaryTelephone": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "PrimaryEmail": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "JobTitle": "sample string 6",
      "Id": 7
    },
    "Id": 6
  }
]