PlanRadar Invitation V1 API

swagger: '2.0'
info:
  title: PlanRadar's API Documentation Approval Requests V2 Invitation V1 API
  version: '2.0'
  description: "Welcome to PlanRadar's API documentation, here you can find all the details about our APIs as well as test them online.<br />\n        <h5>Rate Limits</h5>30 requests per minute per account, aggregated across all tokens.<br />\n        If the threshold is exceeded, a 5-minute cooldown is applied to the account, aggregated across all tokens.<br />\n        During the cooldown period, further requests may be rejected until the cooldown ends.<br />\n        In rare cases, an endpoint may have a different rate limit than the default. When that happens, the differing limit will be explicitly stated in the API documentation for that endpoint.<br />\n        <h5>Access Key</h5>In order to be able to access any API you have to create an access token.Therefore you have to follow these steps:-\n        <ul>\n          <li>Go to your profile page and click on Personal Access Tokens on the left side bar</li><li>Click on the 'Create Access Token' top right button in order to create a new access token.</li><li>Copy the created token and paste it into the field that pops up when you click on the 'Authorize' button </li><li>Note: you can copy the token only once.</li><li>Now you can easily access any API</li>\n        </ul>\n        <h5>V2 APIs</h5>We are currently working on upgrading all our APIs to v2, and we recommend that you use v2 APIs if it is available.\n        <p>V2 APIs are faster, robust and more flexible than v1 APIs</p>"
basePath: /
schemes:
- https
- http
consumes:
- application/json
produces:
- application/json
tags:
- name: Invitation V1
paths:
  /api/v1/{customer_id}/invitations/{user_id}:
    get:
      summary: resend invitation
      tags:
      - Invitation V1
      description: resend an invitation for user has been invited before
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: user_id
        in: path
        type: string
        required: true
      responses:
        '404':
          description: Data not found
    delete:
      summary: 'delete invitation '
      tags:
      - Invitation V1
      description: delete a invitation
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: user_id
        in: path
        type: string
        required: true
      responses:
        '404':
          description: Data not found
  /api/v1/{customer_id}/invitations:
    post:
      summary: Invite user
      tags:
      - Invitation V1
      security:
      - apiKey: []
      description: invite user
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: user_id
        in: path
        type: string
        required: true
      - name: user
        in: body
        schema:
          type: object
          properties:
            data:
              type: object
              properties:
                attributes:
                  type: object
                  properties:
                    active:
                      type: boolean
                    company:
                      type: string
                    firstname:
                      type: string
                    group_ids:
                      type: array
                      items: []
                    is_mobile_syncs:
                      type: array
                      items: []
                    lastname:
                      type: string
                    mail:
                      type: string
                    password:
                      type: string
                    permissions:
                      type: object
                      properties:
                        defects:
                          type: boolean
                    project_ids:
                      type: array
                      items: []
                    retype_password:
                      type: string
                    role_ids:
                      type: array
                      items: []
                    subcontractor:
                      type: boolean
                    time_zone_name:
                      type: string
                    watcher:
                      type: boolean
      responses:
        '404':
          description: Data not found
securityDefinitions:
  apiKey:
    type: apiKey
    name: X-PlanRadar-API-Key
    in: header
externalDocs:
  description: Find out more about our development portal
  url: https://www.planradar.com/knowledge-base-overview/