PEXA

PEXA User API

The User API from PEXA — 2 operation(s) for user.

GitHub OpenAPI

Operations 2

GET /v1/user Retrieves user profile #
GET /v3/user Retrieves user profile #

Documentation

📖
APIReference
https://developer.pexa.com.au/EXP_ConsolidatedDischarge/api/apireference/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/pexa/refs/heads/main/authentication/pexa-authentication.yml
📖
APIReference
https://developer.pexa.com.au/Marketplace/api/apireference/
📖
Documentation
https://developer.pexa.com.au/Marketplace/api/apireference/

Specifications

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

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/pexa/refs/heads/main/conventions/pexa-conventions.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/pexa/refs/heads/main/sandbox/pexa-sandbox.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/pexa/refs/heads/main/scopes/pexa-scopes.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/pexa-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

pexa-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Pexa User API
  version: '1.0'
  description: 'Operations tagged User across 2 of this provider''s published API definitions: pexa-exchange-api-legacy-swagger.json, pexa-exchange-api-swagger.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://localhost/
tags:
- name: User
paths:
  /v1/user:
    get:
      tags:
      - User
      summary: Retrieves user profile
      description: "This API will return user profile which is belong to logged in user.  \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip)."
      operationId: getUserProfileUsingGET
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._1.UserProfileRetrievalResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._1.UserProfileRetrievalResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
    servers:
    - url: https://localhost/
  /v3/user:
    get:
      tags:
      - User
      summary: Retrieves user profile
      description: "This API will return user profile which is belong to logged in user.\n\n Scopes:\n<i>au_pub_cert_pexa_user_api_v3_read</i> (non-prod)\n<i>au_pub_pexa_user_api_v3_read</i> (prod)"
      operationId: getUserProfileUsingGET
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._1.UserProfileRetrievalResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._1.UserProfileRetrievalResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
components:
  schemas:
    au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.WorkgroupList.Workgroup:
      type: object
      properties:
        workgroupId:
          type: string
          xml:
            name: WorkgroupId
            attribute: false
            wrapped: false
        workgroupName:
          type: string
          xml:
            name: WorkgroupName
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.WorkgroupList.Workgroup
      xml:
        name: Workgroup
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile:
      type: object
      properties:
        subscriberId:
          type: string
          example: 212
          xml:
            name: SubscriberId
            attribute: false
            wrapped: false
        subscriberName:
          type: string
          example: Law Conveyancing
          xml:
            name: SubscriberName
            attribute: false
            wrapped: false
        subscriberType:
          type: string
          example: Conveyancer
          xml:
            name: SubscriberType
            attribute: false
            wrapped: false
        subscriberDualSignFss:
          type: string
          example: false
          xml:
            name: SubscriberDualSignFss
            attribute: false
            wrapped: false
        subscriberDualSignDoc:
          type: string
          example: false
          xml:
            name: SubscriberDualSignDoc
            attribute: false
            wrapped: false
        userId:
          type: string
          example: 100
          xml:
            name: UserId
            attribute: false
            wrapped: false
        username:
          type: string
          example: conveyancer@pexa.com.au
          xml:
            name: Username
            attribute: false
            wrapped: false
        userType:
          type: string
          example: ROLE_SUBSCRIBER_MANAGER
          xml:
            name: UserType
            attribute: false
            wrapped: false
        userFirstName:
          type: string
          example: Gwen
          xml:
            name: UserFirstName
            attribute: false
            wrapped: false
        userLastName:
          type: string
          example: Last
          xml:
            name: UserLastName
            attribute: false
            wrapped: false
        workgroupList:
          xml:
            name: WorkgroupList
            attribute: false
            wrapped: false
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.WorkgroupList'
        userPermissionsList:
          xml:
            name: UserPermissionsList
            attribute: false
            wrapped: false
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.UserPermissionsList'
      title: au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile
      xml:
        name: UserProfile
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.UserProfileRetrievalResponse:
      type: object
      properties:
        userProfile:
          xml:
            name: UserProfile
            attribute: false
            wrapped: false
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile'
      title: au.net.pexa.api.schema._1.UserProfileRetrievalResponse
      xml:
        name: UserProfileRetrievalResponse
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.UserPermissionsList:
      type: object
      properties:
        userPermissions:
          type: array
          xml:
            name: UserPermission
            attribute: false
            wrapped: false
          items:
            type: string
      title: au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.UserPermissionsList
      xml:
        name: UserPermissionsList
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.WorkgroupList:
      type: object
      properties:
        workgroups:
          type: array
          xml:
            name: Workgroup
            attribute: false
            wrapped: false
          items:
            $ref: '#/components/schemas/au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.WorkgroupList.Workgroup'
      title: au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.WorkgroupList
      xml:
        name: WorkgroupList
        attribute: false
        wrapped: false
x-refined-from:
- pexa-exchange-api-legacy-swagger.json
- pexa-exchange-api-swagger.json