find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/tinvio-com:tinvio-com-organization-users-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Tinvio Com Organization Users API
  version: '1.0'
  contact:
    email: build.with@jaz.ai
    name: API Support
    url: https://jaz.ai
  description: 'Operations tagged Organization Users across 2 of this provider''s published API definitions: tinvio-com-openapi-original.yaml, tinvio-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.getjaz.com
tags:
- description: Manage organization users and invitations.
  name: Organization Users
paths:
  /api/v1/organization-users:
    get:
      description: List the organization's users, paginated.
      operationId: list-organization-users
      parameters:
      - description: Maximum number of results per page (max 1000).
        in: query
        name: limit
        schema:
          type: integer
          default: 100
      - description: Zero-indexed row offset into the result set.
        in: query
        name: offset
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: List Organization Users
      tags:
      - Organization Users
    servers:
    - url: https://api.getjaz.com
  /api/v1/organization-users/invite:
    post:
      description: Invite a user to the organization by email.
      operationId: create-organization-user-invite
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Invite Organization User
      tags:
      - Organization Users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InviteOrganizationUserClientRequest'
        description: The invite organization user request.
        required: true
    servers:
    - url: https://api.getjaz.com
  /api/v1/organization-users/search:
    post:
      description: Search organization users with filters, sort, and pagination.
      operationId: search-organization-user
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Search Organization Users
      tags:
      - Organization Users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchOrganizationUsersRequest'
        description: Search filters, sort, and pagination.
        required: true
    servers:
    - url: https://api.getjaz.com
  /api/v1/organization-users/{resourceId}:
    delete:
      description: Remove the user from the organization.
      operationId: delete-organization-user
      parameters:
      - description: Resource ID of the organization user.
        in: path
        name: resourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Delete Organization User
      tags:
      - Organization Users
    get:
      description: Get a single organization user by its resource ID.
      operationId: get-organization-user
      parameters:
      - description: Resource ID of the organization user.
        in: path
        name: resourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Get Organization User
      tags:
      - Organization Users
    put:
      description: Update an existing organization user.
      operationId: update-organization-user
      parameters:
      - description: Resource ID of the organization user.
        in: path
        name: resourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Update Organization User
      tags:
      - Organization Users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationUserClientRequest'
        description: The organization user fields to update.
        required: true
    servers:
    - url: https://api.getjaz.com
components:
  schemas:
    AddOrganizationUserModuleRoleInput:
      properties:
        moduleName:
          description: Module the role applies to.
          enum:
          - ORGANIZATION
          - USER_MANAGEMENT
          - BILLING
          - ACCOUNTING
          - SALES
          - PURCHASES
          - REPORTS
          - FIXED_ASSET
          type: string
        roleCode:
          description: Role code granted for the module.
          enum:
          - ADMIN
          - PREPARER
          - MEMBER
          - NO_ACCESS
          type: string
      required:
      - moduleName
      type: object
    OrganizationUserSortFilter:
      properties:
        order:
          description: Sort direction, ASC or DESC.
          enum:
          - ASC
          - asc
          - DESC
          - desc
          type: string
        sortBy:
          description: Fields to sort by, in priority order.
          items:
            type: string
          maxItems: 9
          type: array
          uniqueItems: true
      required:
      - order
      - sortBy
      type: object
    ErrorResponse:
      properties:
        error:
          allOf:
          - $ref: '#/components/schemas/ErrorResponseData'
          description: Error details.
      type: object
    BaseResponse:
      properties:
        data:
          description: The response object.
      type: object
    UserNestedFilter:
      properties:
        deleted:
          allOf:
          - $ref: '#/components/schemas/BooleanExpression'
          description: Filter by whether the user record is deleted.
        email:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by email address.
        firstName:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by first name.
        lastName:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by last name.
        phoneRegistered:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by registered phone number.
        resourceId:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by user resource ID.
        status:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: 'Filter by user status: ACTIVE or INACTIVE.'
      type: object
    BooleanExpression:
      properties:
        eq:
          description: Match values equal to this.
          type: boolean
      type: object
    UpdateOrganizationUserClientRequest:
      properties:
        moduleRoles:
          description: Module roles granted to the user.
          items:
            $ref: '#/components/schemas/AddOrganizationUserModuleRoleInput'
          maxItems: 100
          type: array
        resourceId:
          description: Resource ID of the organization user, from the URL path.
          type: string
        userType:
          description: User type granted to the user.
          enum:
          - ADMIN
          - CUSTOM_USER
          type: string
      required:
      - resourceId
      type: object
    StringExpression:
      properties:
        contains:
          description: Match values containing this substring.
          type: string
        endWith:
          description: Match values ending with this term (case sensitive).
          type: string
        eq:
          description: Match values equal to this.
          type: string
        in:
          description: Match values equal to any of these.
          items:
            type: string
          maxItems: 100
          type: array
        isBlank:
          description: Match records where the field is null or empty ("true") or neither ("false").
          type: string
        isNotBlank:
          description: Match records where the field is neither null nor empty ("true").
          type: string
        isNull:
          description: Match records where the field is null ("true") or not null ("false").
          type: string
        likeIn:
          description: Match values containing any of these substrings.
          items:
            type: string
          maxItems: 100
          type: array
        neq:
          description: Match values not equal to this.
          type: string
        notContains:
          description: Match values not containing this substring.
          type: string
        notEndWith:
          description: Match values not ending with this term (case sensitive).
          type: string
        notStartWith:
          description: Match values not starting with this term (case sensitive).
          type: string
        reg:
          description: Match values containing any of these terms. This is a substring match, not a regular expression, despite the name.
          items:
            type: string
          maxItems: 100
          type: array
        startWith:
          description: Match values starting with this term (case sensitive).
          type: string
      required:
      - in
      - likeIn
      - reg
      type: object
    InviteOrganizationUserClientRequest:
      properties:
        email:
          description: Email address the invitation is sent to.
          maxLength: 255
          type: string
        firstName:
          description: First name of the invitee.
          maxLength: 255
          type: string
        lastName:
          description: Last name of the invitee.
          maxLength: 255
          type: string
        moduleRoles:
          description: Module roles granted to the user.
          items:
            $ref: '#/components/schemas/AddOrganizationUserModuleRoleInput'
          maxItems: 100
          type: array
        userType:
          description: User type granted to the user.
          enum:
          - ADMIN
          - CUSTOM_USER
          type: string
      type: object
    OrganizationUserFilter:
      properties:
        and:
          description: Combine with another filter using AND.
          type: object
        email:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by email address.
        or:
          description: Combine with another filter using OR.
          type: object
        resourceId:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by organization user resource ID.
        status:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by status.
        user:
          allOf:
          - $ref: '#/components/schemas/UserNestedFilter'
          description: Filter by user fields.
        userResourceId:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by user resource ID.
        userType:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by user type.
      type: object
    SearchOrganizationUsersRequest:
      properties:
        filter:
          allOf:
          - $ref: '#/components/schemas/OrganizationUserFilter'
          description: Filter conditions. Combine with and and or for complex queries.
        limit:
          default: 100
          description: Maximum number of results per page (max 1000).
          maximum: 1000
          minimum: 1
          type: integer
        offset:
          default: 0
          description: Zero-indexed row offset into the result set. Sort is required when offset is set.
          maximum: 65536
          minimum: 0
          type: integer
        query:
          description: 'Structured search query using Jaz search operators. Parsed automatically into filter fields.

            Explicit filter fields override query results on conflict.

            Example: "status:unpaid AND $500+".'
          maxLength: 1000
          type: string
        sort:
          allOf:
          - $ref: '#/components/schemas/OrganizationUserSortFilter'
          description: Sort order. Required when offset is set.
      type: object
    ErrorResponseData:
      properties:
        error_type:
          description: Error category, for example validation_error, invalid_request_body, or internal_server_error.
          example: validation_error
          type: string
        errors:
          description: Error messages describing what went wrong.
          items:
            type: string
          type: array
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Organization API key. Pass it in the x-jk-api-key header on every request.
      in: header
      name: x-jk-api-key
      type: apiKey
x-refined-from:
- tinvio-com-openapi-original.yaml
- tinvio-com-openapi.yml