Substy Developers
Team

List team role audit events

List agency role and permission audit events with actor, action, permission and date filters. Use the numeric cursor as an offset for later pages.

GET/v1/agencies/{agencyId}/team/role-audit-events

List agency role and permission audit events with actor, action, permission and date filters. Use the numeric cursor as an offset for later pages.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length

Query Parameters

limit?number
Range1 <= value <= 100
Default50
cursor?number
Range0 <= value
Default0
actorIds?array<string>
actions?array<>
permissions?array<>
dateFrom?string
Match^(?:(?:\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))$
Formatdate-time
dateTo?string
Match^(?:(?:\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))$
Formatdate-time
sortBy?string
Default"createdAt"

Value in

  • "createdAt"
  • "action"
  • "targetType"
sortOrder?string
Default"desc"

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/team/role-audit-events" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "items": [      {        "agencyId": "string",        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "metadata": null,        "actorId": "string",        "action": "ROLE_CREATED",        "targetType": "string",        "targetId": null,        "permission": null      }    ],    "total": 0  },  "meta": {    "requestId": "string"  }}

List assignable team roles GET

List only roles the current account can assign to agency members or invitations. Use these role IDs when inviting members or changing roles.

Update team role PATCH

Replace an editable agency role's name, presentation, permission set and data-visibility settings. Changes affect members assigned to the role.