PRIMIS

PRIMIS User API

User API

GitHub OpenAPI

Operations 10

GET /users Get all the users for the retailer
GET /users/{id} Gets the user
PUT /users/{id} Update the user
DELETE /users/{id} Delete the user
GET /users/verify/resend Resend the user verification email
GET /invitations/{token} Get the user invitation
GET /invitations/resend Resend the user invitation email
POST /invitations/register/{token} Register the user (Used for invitations and email verifications)
POST /auth/reset-password/{token} Reset the user's password
POST /auth/change-password Change the user's password

Documentation

📖
APIReference
https://api.primis.cx/api-docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/openapi/primis-user-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/conventions/primis-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/errors/primis-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/data-model/primis-data-model.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/lifecycle/primis-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/conformance/primis-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/sandbox/primis-sandbox.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/primis-user-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

primis-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: REST Auth User API
  version: 1.1.0
  description: Primis API docs
servers:
- url: https://api.primis.cx
  description: Production server
- url: https://api.qa.primis.cx
  description: QA Server
tags:
- name: User
  description: User API
paths:
  /users:
    get:
      tags:
      - User
      summary: Get all the users for the retailer
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
        '500':
          description: Server Error
  /users/{id}:
    get:
      tags:
      - User
      summary: Gets the user
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
        description: Id of the user
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '500':
          description: Server Error
    put:
      tags:
      - User
      summary: Update the user
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
        description: Id of the user
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '500':
          description: Server Error
    delete:
      tags:
      - User
      summary: Delete the user
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '500':
          description: Server Error
  /users/verify/resend:
    get:
      tags:
      - User
      summary: Resend the user verification email
      parameters:
      - in: query
        name: email
        schema:
          type: string
        required: true
        description: Email requiring a resend
      responses:
        '200':
          description: Ok
        '500':
          description: Server Error
  /invitations/{token}:
    get:
      tags:
      - User
      summary: Get the user invitation
      parameters:
      - in: path
        name: token
        schema:
          type: string
        required: true
        description: The token of the invitation
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  user:
                    $ref: '#/components/schemas/Invitation'
        '500':
          description: Server Error
  /invitations/resend:
    get:
      tags:
      - User
      summary: Resend the user invitation email
      parameters:
      - in: query
        name: email
        schema:
          type: string
        required: true
        description: Email requiring a resend
      responses:
        '200':
          description: Ok
        '500':
          description: Server Error
  /invitations/register/{token}:
    post:
      tags:
      - User
      summary: Register the user (Used for invitations and email verifications)
      parameters:
      - in: path
        name: token
        schema:
          type: string
        required: true
        description: Identifing token of the invite
      requestBody:
        content:
          application/json:
            schema:
              properties:
                password:
                  type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  user:
                    $ref: '#/components/schemas/User'
                  access:
                    $ref: '#/components/schemas/UserFeatureAccess'
                  jwt:
                    type: string
        '500':
          description: Server Error
  /auth/reset-password/{token}:
    post:
      tags:
      - User
      summary: Reset the user's password
      parameters:
      - in: path
        name: token
        schema:
          type: string
        required: true
        description: Reset password token
      requestBody:
        content:
          application/json:
            schema:
              properties:
                password:
                  type: string
      responses:
        '200':
          description: Ok
        '500':
          description: Server Error
  /auth/change-password:
    post:
      tags:
      - User
      summary: Change the user's password
      requestBody:
        content:
          application/json:
            schema:
              properties:
                currentPassword:
                  type: string
                newPassword:
                  type: string
      responses:
        '200':
          description: Ok
        '500':
          description: Server Error
components:
  schemas:
    Invitation:
      properties:
        user:
          $ref: '#/components/schemas/User'
        token:
          title: Invitation.token
          type: string
        redeemed:
          title: Invitation.redeemed
          type: boolean
        expiration:
          type: string
        verification:
          title: Invitation.verification
          type: boolean
      required:
      - user
      - token
      - redeemed
      - expiration
      additionalProperties: false
      title: Invitation
      type: object
    User:
      properties:
        id:
          title: User.id
          type: string
        retailer:
          title: User.retailer
          type: string
        name:
          title: User.name
          type: string
        surname:
          title: User.surname
          type: string
        email:
          title: User.email
          type: string
        role:
          type: string
          enum:
          - retail-admin
          - developer
          - marketing
        blocked:
          title: User.blocked
          type: boolean
      required:
      - email
      additionalProperties: false
      title: User
      type: object
    UserFeatureAccess:
      properties:
        subscription:
          type: array
          items:
            $ref: '#/components/schemas/FeaturePermissions'
        role:
          type: array
          items:
            $ref: '#/components/schemas/FeaturePermissions'
      title: UserFeatureAccess
      type: object
    FeaturePermissions:
      properties:
        feature:
          type: string
        actions:
          items:
            type: string
          title: FeaturePermissions.actions
          type: array
      required:
      - feature
      - actions
      additionalProperties: false
      title: FeaturePermissions
      type: object
  securitySchemes:
    bearerAuth:
      type: https
      scheme: bearer
      bearerFormat: JWT