v3

latestSwagger 2.02026-08-067506752.0 MB

profile-tab

Return a particular profile tab by id

get/v1/org/{orgId}/profile-tab/{profileTabId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

profileTabIdstring required

Content id

Response

successful operation

idstring required

globally unique id

orgIdstring required

parent organization id

labelstring required

human-readable name of profile tab

status'ACTIVE' | 'INACTIVE' required

status of the profile tab

targetFilterstring

filter that controls on which profiles this tab will appear

readFilterstring

filter that controls which viewers can read this profile tab. The profileTab:read permission, if present, overrides this filter

sortinteger

sort order

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "label": "Performance",
  "blocks": [
    {
      "formIds": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ],
  "layout": {
    "rows": [
      {
        "columns": [
          {
            "blocks": [
              {
                "formIds": [
                  "588f7ee98f138b19220041a7"
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}