Broadcast

Find all broadcasts with optional filters

GET

http://localhost:3000/api/broadcasts

curl -X GET 'http://localhost:3000/api/broadcasts' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('http://localhost:3000/api/broadcasts', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'http://localhost:3000/api/broadcasts',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

[
  {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "organizationId": "string",
    "entity": "Broadcast",
    "entityId": "string",
    "title": "string",
    "content": {},
    "category": "STATUS_REPORT",
    "visibilityMode": "ENTITY_MEMBERS",
    "audienceRules": {},
    "publishedAt": "2024-01-15T09:30:00Z",
    "employeeId": "string"
  }
]

Parameters

selectObjectquery

relationsObjectquery

whereObjectrequiredquery

orderObjectquery

withDeletedbooleanquery

takenumber[0, 100]query

skipnumber>= 0query

Response

200OKArray<Broadcast>

Found broadcasts

Response fields application/json

Array<Broadcast>

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

entitystringBroadcastCandidateCommentContactCurrencyDailyPlanDashboardDashboardWidgetDocumentEmployeeExpenseInvoiceIncomeLanguageOrganizationOrganizationContactOrganizationDepartmentOrganizationDocumentOrganizationProjectOrganizationTeamOrganizationProjectModuleOrganizationSprintOrganizationVendorResourceLinkScreeningTaskOrganizationStrategicInitiativeTaskTaskLinkedIssueTaskViewUserTenantrequired

entityIdstringrequired

titlestringrequired

contentobjectrequired

categorystringSTATUS_REPORTMILESTONEANNOUNCEMENTALERTDECISIONCHANGELOGrequired

visibilityModestringENTITY_MEMBERSORGANIZATIONRESTRICTEDEXTERNAL_VIEWrequired

audienceRulesobject

publishedAtstring<date-time>

employeeIdstring

401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Records not found

Authorization

bearerhttp (bearer) in header

Enter JWT token

Stack Overflow Website Demo