List Briefings

Returns one page of Briefings, most recently updated first. Use scope to choose between organization Briefings and tenant Briefings.

To list every Briefing in one tenant, including those its users created, call with an organization Admin's token, scope=tenants and tenantId:

GET /api/v1/briefings?scope=tenants&tenantId=tenant_123

Leave out tenantId to list tenant Briefings across all tenants.

Authorization

BearerAuth

AuthorizationBearer <token>

A project-scoped access token. Generate one via the Token API with your project ID and project secret.

In: header

Which Briefings to list. organization (the default) lists Briefings not tied to a tenant. tenants lists Briefings in tenants, and requires an organization Admin. The value is plural: tenant is rejected with 400. Ignored for tenant users, who always see only their own Briefings.

Default"organization"

Value in"organization" | "tenants"

tenantId?string

With scope=tenants, only Briefings in this tenant. Ignored otherwise.

tenantUserId?string

With scope=tenants, only Briefings this tenant user created. Ignored otherwise.

status?string

Only Briefings with this status. Case does not matter.

Value in"ACTIVE" | "PAUSED" | "DISABLED"

search?string

Only Briefings whose name contains this text, ignoring case.

page?integer

Page number, starting at 1.

Default1

Range1 <= value <= 10000

pageSize?integer

Briefings per page.

Default25

Range1 <= value <= 100

Response Body

`application/json`

curl -X get "https://semaphor.cloud/api/v1/briefings"

{
  "briefings": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "status": "ACTIVE",
      "scheduleExpr": "0 8 * * 1",
      "timezone": "America/New_York",
      "nextRunAt": "2019-08-24T14:15:22Z",
      "scope": {
        "type": "organization",
        "label": "string",
        "tenantId": "string",
        "tenantName": "string"
      },
      "creator": {
        "type": "organization",
        "id": "string",
        "name": "string",
        "email": "string",
        "label": "string"
      },
      "deliveryConfig": {
        "recipients": [
          {
            "type": "tenant_user",
            "tenantUserId": "string"
          }
        ],
        "channels": [
          "EMAIL"
        ],
        "subject": "string",
        "message": "string"
      },
      "source": {},
      "body": {},
      "attachments": [
        {}
      ],
      "presentation": {},
      "lastRunAt": "2019-08-24T14:15:22Z",
      "lastRunStatus": "string",
      "hasActiveRun": true,
      "canManage": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "page": 0,
  "pageSize": 0
}

{
  "error": "string",
  "code": "string"
}

{
  "error": "string",
  "code": "string"
}

{
  "error": "string",
  "code": "string"
}

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

`application/json`

`application/json`

`application/json`

`application/json`