Signal AI Organisation API

openapi: 3.2.0
info:
  title: Signal AI Organisation API
  description: '# Overview


    The Signal AI API is an HTTP+JSON API offering programmatic access to Signal AI''s decision augmentation platform.'
  version: v1.3
servers:
- url: https://api.signal-ai.com
security:
- OAuth2:
  - default
tags:
- name: Organisation
paths:
  /users:
    get:
      operationId: list-users
      security:
      - OAuth2:
        - manage-organisation
      tags:
      - Organisation
      summary: List users in your organisation
      description: Returns all users in the organisation of the authenticated API credential. Requires a credential with the `manage-organisation` capability, granted to organisation administrators.
      responses:
        '200':
          description: Returns the list of users in your organisation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersResponse'
components:
  schemas:
    User:
      type: object
      required:
      - id
      additionalProperties: false
      properties:
        updated-at:
          type: string
        email:
          type: string
        last-name:
          type: string
        timezone:
          type: string
        roles:
          type: array
          items:
            type: string
          description: Role names held by the user
        company-role:
          type: string
          description: Free-text job title
        first-name:
          type: string
        id:
          $ref: '#/components/schemas/ResourceId'
        activated:
          type: boolean
        created-at:
          type: string
    UsersResponse:
      type: object
      required:
      - users
      additionalProperties: false
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/User'
    ResourceId:
      type: string
      format: uuid
      pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
      example: bcd2d868-ed38-4382-b94a-622a30fc3215
  securitySchemes:
    OAuth2:
      type: oauth2
      description: "To obtain the Bearer Token using the Client ID / Secret pair provided to you:\n\n```bash\ncurl -X POST \\\n  -d 'grant_type=client_credentials' \\\n  -d 'client_id=YOUR_CLIENT_ID' \\\n  -d 'client_secret=YOUR_CLIENT_SECRET' \\\n  https://api.signal-ai.com/auth/token\n```\n\nThis will return the following JSON response:\n\n```json\n{\n    \"access_token\": \"eyJhbGciOi…\",\n    \"expires_in\": 86400,\n    …\n}\n```\n\nYou must send the `access_token` from this response in the Authorization header when making requests to other API endpoints:\n\n```bash\ncurl -H \"Authorization: Bearer eyJhbGciOi…\" \\\n  https://api.signal-ai.com/…\n```\n\nAccess tokens will expire 24 hours from the time they were issued.\n"
      flows:
        clientCredentials:
          tokenUrl: https://api.signal-ai.com/auth/token
          scopes:
            default: Access to discovery endpoints
            search: Access to content search endpoint
            metrics: Access to content metrics endpoint
            affinity: Access to concept affinity endpoints
            events: Access to events endpoint
            risk-events: Access to risk events
            manage-organisation: Access to organisation administration endpoints
x-tagGroups:
- name: Concept Discovery
  tags:
  - Publication sources
  - Topics
  - Entities
  - Categories
- name: Search
  tags:
  - Content Search
- name: Metrics
  tags:
  - Content Metrics
- name: Affinity
  x-displayName: Affinity
  tags:
  - Affinity
- name: Events
  x-displayName: Events
  tags:
  - Events
- name: Risk (Alpha)
  tags:
  - Risk Events
- name: Organisation
  tags:
  - Organisation