Nimble Users API

The authenticated user record — the credential-verification endpoint. 1 operation(s).

OpenAPI Specification

nimble-users-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Nimble Users API
  description: Nimble CRM Users operations. Split by tag from the OpenAPI Nimble publishes at https://www.nimble.com/developers/docs/
    (embedded Redoc spec). Base host https://app.nimble.com.
  version: v1
servers:
- url: https://app.nimble.com
tags:
- name: Users
  description: User management
paths:
  /api/v1/myself:
    get:
      description: Returns information about authenticated user. User_id from this response can be used
        to assign different Nimble entities to this user. Such as tasks, contacts, etc.
      operationId: get-myself
      summary: Current user info
      tags:
      - Users
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  company_id:
                    type: string
                    example: 4c2118ad54397f271b000000
                  company_size:
                    type: integer
                    example: 3
                  email:
                    type: string
                    example: some@user.com
                  name:
                    type: string
                    example: John Doe
                  user_id:
                    type: string
                    example: 4f2acc3142a053dda595f00b
                required:
                - user_id
                - company_id
                - email
                - name
                - company_size
                type: object
          description: ''
security:
- ApiKey: []
components:
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Nimble-Token