> ## Documentation Index
> Fetch the complete documentation index at: https://docs.watchdog.no/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a shared team

> Creates a team with a unique name, an optional filter and optional initial members. A team without a filter matches no records. Teams organize work; they do not grant access to records.



## OpenAPI

````yaml /openapi.json post /v1/teams
openapi: 3.1.0
info:
  title: Watchdog API
  version: 1.0.0
  description: >-
    The Watchdog API is served from https://api.watchdog.no. Request bodies are
    limited to 2 MiB unless an endpoint says otherwise. Files are uploaded
    directly to storage, not through the API.
servers:
  - url: https://api.watchdog.no
    description: Watchdog API
security: []
paths:
  /v1/teams:
    post:
      tags:
        - Teams
        - Settings
      summary: Create a shared team
      description: >-
        Creates a team with a unique name, an optional filter and optional
        initial members. A team without a filter matches no records. Teams
        organize work; they do not grant access to records.
      operationId: createTeam
      parameters:
        - name: X-Organization-Id
          in: header
          required: false
          schema:
            type: string
          description: >-
            The organization to act in. Required for personal API keys; list the
            organizations you can access with GET /v1/organizations.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTeam'
      responses:
        '201':
          description: The created team.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Location:
              schema:
                type: string
              required: false
              description: Relative URL of the created or accepted resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'
        '400':
          description: >-
            The request is invalid. details lists up to 20 field errors. Request
            bodies are limited to 2 MiB.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_validation_error'
              example:
                error:
                  code: validation_error
                  message: >-
                    The request is invalid. details lists up to 20 field errors.
                    Request bodies are limited to 2 MiB.
                  request_id: req_example
        '401':
          description: The bearer token is missing or invalid.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            WWW-Authenticate:
              schema:
                type: string
              required: false
              description: Bearer authentication challenge, when supplied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_invalid_token'
              example:
                error:
                  code: invalid_token
                  message: The bearer token is missing or invalid.
                  request_id: req_example
        '403':
          description: >-
            Access denied. The error code says why: forbidden, token_disabled,
            organization_required, insufficient_role or mfa_required.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required
              example:
                error:
                  code: forbidden
                  message: >-
                    Access denied. The error code says why: forbidden,
                    token_disabled, organization_required, insufficient_role or
                    mfa_required.
                  request_id: req_example
        '404':
          description: The resource does not exist in the current organization.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_not_found'
              example:
                error:
                  code: not_found
                  message: The resource does not exist in the current organization.
                  request_id: req_example
        '409':
          description: >-
            A team with this name already exists. Names are case-sensitive.
            Nothing was saved.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_conflict'
              example:
                error:
                  code: conflict
                  message: >-
                    A team with this name already exists. Names are
                    case-sensitive. Nothing was saved.
                  request_id: req_example
        '429':
          description: Too many requests. Wait for the Retry-After delay before retrying.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_rate_limit_exceeded'
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Wait for the Retry-After delay before
                    retrying.
                  request_id: req_example
        '500':
          description: >-
            Unexpected server failure. Include the request ID when contacting
            support.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_internal_error'
              example:
                error:
                  code: internal_error
                  message: >-
                    Unexpected server failure. Include the request ID when
                    contacting support.
                  request_id: req_example
        '503':
          description: >-
            Temporarily unavailable. Retry after the Retry-After delay, when
            provided.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_service_unavailable'
              example:
                error:
                  code: service_unavailable
                  message: >-
                    Temporarily unavailable. Retry after the Retry-After delay,
                    when provided.
                  request_id: req_example
      security:
        - ApiKeyBearer: []
components:
  schemas:
    CreateTeam:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 100
        filter:
          type:
            - object
            - 'null'
          properties:
            schema_version:
              type: number
              enum:
                - 1
            root:
              $ref: '#/components/schemas/TeamFilterRoot'
          required:
            - schema_version
            - root
          additionalProperties: false
          description: >-
            The team filter. On update, omit to keep it, send null to clear it,
            or send a complete definition to replace it. A team without a filter
            matches no records.
        user_ids:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 255
          maxItems: 100
      required:
        - name
      additionalProperties: false
    Team:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        references:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type:
                  - string
                  - 'null'
              missing:
                type: boolean
              supplier_names:
                type: array
                items:
                  type: string
                description: Supplier names for agreement references.
              type:
                type: string
                enum:
                  - supplier
                  - recipient
                  - agreement
                  - agreement_tag
            required:
              - id
              - name
              - missing
              - type
        filter:
          $ref: '#/components/schemas/StoredSubscriptionFilter'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - name
        - filter
        - created_at
        - updated_at
        - references
    Error_validation_error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_error
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_invalid_token:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_token
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - forbidden
                - token_disabled
                - organization_required
                - insufficient_role
                - mfa_required
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_not_found:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - not_found
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_conflict:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - conflict
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_rate_limit_exceeded:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - rate_limit_exceeded
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_internal_error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - internal_error
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_service_unavailable:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - service_unavailable
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    TeamFilterRoot:
      type: object
      properties:
        combinator:
          type: string
          enum:
            - and
            - or
        children:
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/TeamReferenceCondition'
              - $ref: '#/components/schemas/TeamExactTextCondition'
              - $ref: '#/components/schemas/TeamContainsCondition'
              - $ref: '#/components/schemas/TeamNumberCondition'
              - $ref: '#/components/schemas/TeamDateCondition'
              - $ref: '#/components/schemas/TeamRelativeDateCondition'
              - $ref: '#/components/schemas/TeamFilterGroupLevel2'
          minItems: 1
          maxItems: 20
      required:
        - combinator
        - children
      additionalProperties: false
    StoredSubscriptionFilter:
      description: >-
        A saved team filter, returned as stored; it may be null or no longer
        valid. To replace it, send a filter in the shape the team create and
        update requests accept.
    TeamReferenceCondition:
      type: object
      properties:
        field:
          type: string
          enum:
            - supplier.id
            - recipient.id
            - agreement.id
            - agreement.tag
        op:
          type: string
          enum:
            - is
            - is_not
            - is_any_of
            - is_none_of
        value:
          anyOf:
            - type: string
              format: uuid
            - type: array
              items:
                type: string
                format: uuid
              minItems: 1
              maxItems: 100
      required:
        - field
        - op
        - value
      additionalProperties: false
    TeamExactTextCondition:
      type: object
      properties:
        field:
          type: string
          enum:
            - supplier.country
            - invoice.currency
            - invoice.reference
            - invoice.delivery_address
        op:
          type: string
          enum:
            - is
            - is_not
            - is_any_of
            - is_none_of
        value:
          anyOf:
            - type: string
              minLength: 1
            - type: array
              items:
                type: string
                minLength: 1
              minItems: 1
              maxItems: 100
      required:
        - field
        - op
        - value
      additionalProperties: false
    TeamContainsCondition:
      type: object
      properties:
        field:
          type: string
          enum:
            - supplier.country
            - invoice.currency
            - invoice.reference
            - invoice.delivery_address
        op:
          type: string
          enum:
            - contains
            - not_contains
        value:
          type: string
          minLength: 1
      required:
        - field
        - op
        - value
      additionalProperties: false
    TeamNumberCondition:
      type: object
      properties:
        field:
          type: string
          enum:
            - invoice.amount
        op:
          type: string
          enum:
            - eq
            - gt
            - gte
            - lt
            - lte
        value:
          anyOf:
            - type: number
            - type: string
              pattern: ^-?\d+(\.\d+)?$
      required:
        - field
        - op
        - value
      additionalProperties: false
    TeamDateCondition:
      type: object
      properties:
        field:
          type: string
          enum:
            - agreement.expiration_date
            - invoice.issued_date
        op:
          type: string
          enum:
            - 'on'
            - before
            - on_or_before
            - after
            - on_or_after
        value:
          type: string
          format: date
      required:
        - field
        - op
        - value
      additionalProperties: false
    TeamRelativeDateCondition:
      type: object
      properties:
        field:
          type: string
          enum:
            - agreement.expiration_date
            - invoice.issued_date
        op:
          type: string
          enum:
            - within
        value:
          type: string
          enum:
            - last_30_days
            - last_90_days
            - last_365_days
            - expiring_30_days
            - expiring_60_days
            - expiring_90_days
      required:
        - field
        - op
        - value
      additionalProperties: false
    TeamFilterGroupLevel2:
      type: object
      properties:
        combinator:
          type: string
          enum:
            - and
            - or
        children:
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/TeamReferenceCondition'
              - $ref: '#/components/schemas/TeamExactTextCondition'
              - $ref: '#/components/schemas/TeamContainsCondition'
              - $ref: '#/components/schemas/TeamNumberCondition'
              - $ref: '#/components/schemas/TeamDateCondition'
              - $ref: '#/components/schemas/TeamRelativeDateCondition'
              - $ref: '#/components/schemas/TeamFilterGroupLevel3'
          minItems: 1
          maxItems: 20
      required:
        - combinator
        - children
      additionalProperties: false
    TeamFilterGroupLevel3:
      type: object
      properties:
        combinator:
          type: string
          enum:
            - and
            - or
        children:
          type: array
          items:
            $ref: '#/components/schemas/TeamFilterCondition'
          minItems: 1
          maxItems: 20
      required:
        - combinator
        - children
      additionalProperties: false
    TeamFilterCondition:
      anyOf:
        - $ref: '#/components/schemas/TeamReferenceCondition'
        - $ref: '#/components/schemas/TeamExactTextCondition'
        - $ref: '#/components/schemas/TeamContainsCondition'
        - $ref: '#/components/schemas/TeamNumberCondition'
        - $ref: '#/components/schemas/TeamDateCondition'
        - $ref: '#/components/schemas/TeamRelativeDateCondition'
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      description: >-
        Personal API key sent as a bearer token, together with
        X-Organization-Id. The key must have at least the access level the
        endpoint requires (read, write or admin).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.