Zywave

Zywave Profile API

The Profile API from Zywave — 6 operation(s) for profile.

Documentation GitHub OpenAPI

Operations 8

DELETE /api/profiles/v2.1/profile/{typeCode}/current Returns profile details for the user's active profile #

GET /api/profiles/v2.1/profile/{typeCode}/current Returns profile details for the user's active profile #

PUT /api/profiles/v2.1/profile/{typeCode}/current Sets the user's active profile #

GET /api/profiles/v2.1/profile/{typeCode}/current/permissions Returns permission details for the user's active profile #

GET /api/profiles/v2.1/profile/{typeCode}/{id} Returns profile details for a single profile #

GET /api/profiles/v2.1/profile/{typeCode}/{id}/permissions Returns permission details for a single profile #

GET /api/profiles/v2.1/profile/{typeCode} Searches for profiles #

GET /api/profiles/v2.1/profile/{typeCode}/unlinked Searches for unlinked profiles matching the subject's email address #

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/zywave:zywave-profile-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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: Profiles API v2.1 Profile API
  version: v2.1
servers:
- url: https://api.zywave.com
security:
- oidc:
  - api.profiles
  - auth.profile
tags:
- name: Profile
paths:
  /api/profiles/v2.1/profile/{typeCode}/current:
    delete:
      tags:
      - Profile
      summary: Returns profile details for the user's active profile
      operationId: Profile_DeleteCurrentProfile
      parameters:
      - name: typeCode
        in: path
        required: true
        description: The type of profile.
        schema:
          type: string
        x-position: 1
      responses:
        '204':
          description: Ok(Profile)
    get:
      tags:
      - Profile
      summary: Returns profile details for the user's active profile
      operationId: Profile_GetCurrentProfile
      parameters:
      - name: typeCode
        in: path
        required: true
        description: The type of profile.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: Ok(Profile)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - Profile
      summary: Sets the user's active profile
      operationId: Profile_SetCurrentProfile
      parameters:
      - name: typeCode
        in: path
        required: true
        description: The type of profile.
        schema:
          type: string
        x-position: 2
      - name: Profile
        x-originalName: profileContext
        in: header
        schema:
          type:
          - string
          - 'null'
        x-position: 3
      requestBody:
        x-name: id
        description: The profile unique identifier.
        content:
          application/json:
            schema:
              type: string
        required: true
        x-position: 1
      responses:
        '204':
          description: NoContent()
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /api/profiles/v2.1/profile/{typeCode}/current/permissions:
    get:
      tags:
      - Profile
      summary: Returns permission details for the user's active profile
      operationId: Profile_GetCurrentProfilePermissions
      parameters:
      - name: typeCode
        in: path
        required: true
        description: The type of profile.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: Ok(T:Permission[])
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Permission'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /api/profiles/v2.1/profile/{typeCode}/{id}:
    get:
      tags:
      - Profile
      summary: Returns profile details for a single profile
      operationId: Profile_GetProfile
      parameters:
      - name: id
        in: path
        required: true
        description: The profile unique identifier.
        schema:
          type: string
        x-position: 1
      - name: typeCode
        in: path
        required: true
        description: The type of profile.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: Ok(Profile)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /api/profiles/v2.1/profile/{typeCode}/{id}/permissions:
    get:
      tags:
      - Profile
      summary: Returns permission details for a single profile
      operationId: Profile_GetProfilePermissions
      parameters:
      - name: id
        in: path
        required: true
        description: The profile unique identifier.
        schema:
          type: string
        x-position: 1
      - name: typeCode
        in: path
        required: true
        description: The type of profile.
        schema:
          type: string
        x-position: 2
      - name: Profile
        x-originalName: profileContext
        in: header
        schema:
          type: string
        x-position: 3
      responses:
        '200':
          description: Ok(T:Permission[])
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Permission'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /api/profiles/v2.1/profile/{typeCode}:
    get:
      tags:
      - Profile
      summary: Searches for profiles
      operationId: Profile_SearchProfiles
      parameters:
      - name: typeCode
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      - name: pageIndex
        in: query
        description: The search result page index.
        schema:
          type: integer
          default: 0
        x-position: 2
      - name: pageSize
        in: query
        description: The search result page size.
        schema:
          type: integer
          default: 100
        x-position: 3
      - name: term
        in: query
        description: The search term.
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      responses:
        '200':
          description: Ok(T:Profile[])
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Profile'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /api/profiles/v2.1/profile/{typeCode}/unlinked:
    get:
      tags:
      - Profile
      summary: Searches for unlinked profiles matching the subject's email address
      operationId: Profile_SearchUnlinkedProfiles
      parameters:
      - name: typeCode
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      - name: pageIndex
        in: query
        description: The search result page index.
        schema:
          type: integer
          default: 0
        x-position: 2
      - name: pageSize
        in: query
        description: The search result page size.
        schema:
          type: integer
          default: 100
        x-position: 3
      - name: term
        in: query
        description: The search term.
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      responses:
        '200':
          description: Ok(T:Profile[])
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Profile'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    ProblemDetails:
      type: object
      additionalProperties: {}
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
    Permission:
      type: object
      additionalProperties: false
      properties:
        directive:
          description: Defines how the permission should be applied.
          oneOf:
          - $ref: '#/components/schemas/PermissionDirective'
        precedence:
          type: integer
          description: Indicates importance in case of conflict - the highest precedence value is used.
          format: int32
        resourcePath:
          type: string
          description: The path of the resource that the permission applies to.
        rights:
          type: integer
          description: A bit mask indicating what rights are applied.
          format: int32
    PermissionDirective:
      type: string
      description: ''
      x-enumNames:
      - Allow
      - Deny
      enum:
      - Allow
      - Deny
    Profile:
      type: object
      additionalProperties: false
      properties:
        claims:
          type: array
          description: Claim data associated with the profile.
          items:
            $ref: '#/components/schemas/ProfileClaim'
        emailAddress:
          type:
          - string
          - 'null'
          description: The email address associated with the profile.
        id:
          type: string
          description: The unique identifier for the profile.
        isActive:
          type: boolean
          description: Specifies whether the profile is active or inactive.
        profileName:
          type:
          - string
          - 'null'
          description: The name of the profile, as entered by the linked user.
        profileToken:
          type:
          - string
          - 'null'
          description: A contextual token for the profile. This can be used in subsequent API requests, as an alternative to inferring the active profile.
        typeCode:
          type: string
          description: The type of profile.
        userPrincipalId:
          type:
          - string
          - 'null'
          description: The unique identifier of the user linked to the profile.
          format: guid
    ValidationProblemDetails:
      allOf:
      - $ref: '#/components/schemas/HttpValidationProblemDetails'
      - type: object
        additionalProperties: {}
        properties:
          errors:
            type: object
            additionalProperties:
              type: array
              items:
                type: string
    HttpValidationProblemDetails:
      allOf:
      - $ref: '#/components/schemas/ProblemDetails'
      - type: object
        additionalProperties: {}
        properties:
          errors:
            type: object
            additionalProperties:
              type: array
              items:
                type: string
    ClaimValueType:
      type: string
      description: ''
      x-enumNames:
      - Invalid
      - Base64Binary
      - Boolean
      - Date
      - Datetime
      - DaytimeDuration
      - Double
      - DsaKeyValue
      - HexBinary
      - Integer
      - KeyInfo
      - Rfc822Name
      - RsaKeyValue
      - String
      - Time
      - X500Name
      - YearMonthDuration
      enum:
      - Invalid
      - Base64Binary
      - Boolean
      - Date
      - Datetime
      - DaytimeDuration
      - Double
      - DsaKeyValue
      - HexBinary
      - Integer
      - KeyInfo
      - Rfc822Name
      - RsaKeyValue
      - String
      - Time
      - X500Name
      - YearMonthDuration
    ProfileClaim:
      type: object
      additionalProperties: false
      required:
      - type
      - value
      properties:
        type:
          type: string
        value:
          type: string
        valueType:
          $ref: '#/components/schemas/ClaimValueType'
  securitySchemes:
    oidc:
      type: openIdConnect
      openIdConnectUrl: https://auth.zywave.com/.well-known/openid-configuration
x-generator: NSwag v14.7.1.0 (NJsonSchema v11.6.1.0 (Newtonsoft.Json v13.0.0.0))