Jump to

• Request
• Response
• Examples

Get All Integration Users

get

/cpq/rest/v19/integrationUsers

This endpoint retrieves a list of integration users across all companies as JSON.

Request

Query Parameters

• excludeLinks: string
  Excludes given link types from response. Supported only with produces type application/json.

  Allowed Values: [ "self", "child", "parent", "canonical", "next", "prev", "related" ]
• expand: string
  Allows expansion of relationships. Supported only with produces type application/json.

  Allowed Values: [ "groups" ]
• fields: string
  User fields to be returned in response. Supported only with produces type application/json.
• limit: integer
  Specifies the number of records to be fetched. Supported only with produces type application/json.
• offset: integer
  Specifies the starting point from which records are to be fetched. Supported only with produces type application/json.
• orderby: string
  Specifies a comma-separated list of fields to order the response by. Supported only with produces type application/json.
• q: string
  Criteria to filter the users. By default no filtering is applied.
• totalResults: boolean
  Specifies the total records to be included in response or not. Supported only with produces type application/json.

Back to Top

Response

Supported Media Types

• application/json

Default Response

List of intergation users.

Body ()

Root Schema : integrationUser-collection

Type: object

Show Source

• items: array List of users
  Title: List of users

  List of users

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of users",
            "title":"List of users",
            "items":{
                "$ref":"#/definitions/integrationUser"
            }
        }
    }
}

Nested Schema : List of users

Type: array

Title: List of users

List of users

Show Source

• Array of: object integrationUser

{
    "type":"array",
    "description":"List of users",
    "title":"List of users",
    "items":{
        "$ref":"#/definitions/integrationUser"
    }
}

Nested Schema : integrationUser

Type: object

Show Source

• approvalDelegate: string
  Title: Approval Delegate

  Approval Delegate
• company: object Company details
  Title: Company details

  User Company details. Applicable only for Users Across Companies
• currency: object Currency
  Title: Currency

  Currency preference of user. Value holds currency code
• dateAdded: string
  Title: Date Added

  User creation date
• dateFormat: object Date Format
  Title: Date Format

  User preferred date time format
• dateModified: string
  Title: Date Modified

  User modified date
• email: string
  Title: Email

  Email of the user
• firstName: string
  Title: First Name

  First Name of the user
• groups: object Groups
  Title: Groups

  Groups to which the user belongs
• isAccessAdminPermEnabled: boolean
  Title: Access Admin Permission Enabled

  Access Admin Permission Enabled
• isMobileEnabled: boolean
  Title: Is Mobile Enabled

  Is Mobile Enabled
• isNotifyEmail: boolean
  Title: Is Notification Preference Email

  Is notification preference email
• isProxyPermEnabled: boolean
  Title: Proxy Permission Enabled

  Proxy permission enabled
• isSuperUserPermEnabled: boolean
  Title: Is Superuser Permission Enabled

  Is Superuser Permission Enabled
• isWebServicesOnly: boolean
  Title: Web Services Only

  Web Services Only
• language: object Language
  Title: Language

  Language preference of user. Value holds language code
• lastLogin: string
  Title: Last Login Date

  User last loggedin date
• lastName: string
  Title: Last Name

  Last Name of the user
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects
• login: string
  Title: Login Id

  Login Id of the user
• numberFormat: object Number Format
  Title: Number Format

  Preferred number format of user
• oauthClientId: string
  Title: OAuth client Id

  Client Id of the OAuth client that has a 1-to-1 association with the user
• partnerLogin: string
  Title: Partner Login

  Partner Login
• partyId: integer(int64)
  Title: Party Id of the user

  Party Id of the user
• partyNumber: string
  Title: Party Number of the user

  Party Number of the user
• phone: string
  Title: Phone Number

  Phone number of the user
• sfdcOrgId: string
  Title: SFDC Organization ID

  SFDC Organization ID
• timeZone: object TimeZone of user
  Title: TimeZone of user

  User preferred timezone
• type: object Type
  Title: Type

  Type of the user
• units: object Units
  Title: Units

  User preferred units

{
    "type":"object",
    "properties":{
        "login":{
            "type":"string",
            "description":"Login Id of the user",
            "title":"Login Id"
        },
        "firstName":{
            "type":"string",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "email":{
            "type":"string",
            "description":"Email of the user",
            "title":"Email"
        },
        "phone":{
            "type":"string",
            "description":"Phone number of the user",
            "title":"Phone Number"
        },
        "dateAdded":{
            "type":"string",
            "description":"User creation date",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"User modified date",
            "title":"Date Modified"
        },
        "lastLogin":{
            "type":"string",
            "description":"User last loggedin date",
            "title":"Last Login Date"
        },
        "approvalDelegate":{
            "type":"string",
            "description":"Approval Delegate",
            "title":"Approval Delegate"
        },
        "partnerLogin":{
            "type":"string",
            "description":"Partner Login",
            "title":"Partner Login"
        },
        "sfdcOrgId":{
            "type":"string",
            "description":"SFDC Organization ID",
            "title":"SFDC Organization ID"
        },
        "isNotifyEmail":{
            "type":"boolean",
            "description":"Is notification preference email",
            "title":"Is Notification Preference Email"
        },
        "isSuperUserPermEnabled":{
            "type":"boolean",
            "description":"Is Superuser Permission Enabled",
            "title":"Is Superuser Permission Enabled"
        },
        "isWebServicesOnly":{
            "type":"boolean",
            "description":"Web Services Only",
            "title":"Web Services Only"
        },
        "type":{
            "type":"object",
            "description":"Type of the user",
            "title":"Type",
            "properties":{
                "value":{
                    "$ref":"#/definitions/value"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "language":{
            "type":"object",
            "description":"Language preference of user. Value holds language code",
            "title":"Language",
            "properties":{
                "value":{
                    "$ref":"#/definitions/value"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "currency":{
            "type":"object",
            "description":"Currency preference of user. Value holds currency code",
            "title":"Currency",
            "properties":{
                "value":{
                    "$ref":"#/definitions/value"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "numberFormat":{
            "type":"object",
            "description":"Preferred number format of user",
            "title":"Number Format",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "timeZone":{
            "type":"object",
            "description":"User preferred timezone",
            "title":"TimeZone of user",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "units":{
            "type":"object",
            "description":"User preferred units",
            "title":"Units",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "dateFormat":{
            "type":"object",
            "description":"User preferred date time format",
            "title":"Date Format",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "isMobileEnabled":{
            "type":"boolean",
            "description":"Is Mobile Enabled",
            "title":"Is Mobile Enabled"
        },
        "isAccessAdminPermEnabled":{
            "type":"boolean",
            "description":"Access Admin Permission Enabled",
            "title":"Access Admin Permission Enabled"
        },
        "isProxyPermEnabled":{
            "type":"boolean",
            "description":"Proxy permission enabled",
            "title":"Proxy Permission Enabled"
        },
        "company":{
            "$ref":"#/definitions/user-company-props"
        },
        "groups":{
            "type":"object",
            "description":"Groups to which the user belongs",
            "title":"Groups",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/group"
                    }
                }
            }
        },
        "oauthClientId":{
            "type":"string",
            "description":"Client Id of the OAuth client that has a 1-to-1 association with the user",
            "title":"OAuth client Id"
        },
        "partyId":{
            "type":"integer",
            "format":"int64",
            "description":"Party Id of the user",
            "title":"Party Id of the user"
        },
        "partyNumber":{
            "type":"string",
            "description":"Party Number of the user",
            "title":"Party Number of the user"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Company details

Type: object

Title: Company details

User Company details. Applicable only for Users Across Companies

Show Source

• loginName: string
  Title: Company Login Name

  Company Login Name
• name: string
  Title: Company Name

  Company Name

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Company Name",
            "title":"Company Name"
        },
        "loginName":{
            "type":"string",
            "description":"Company Login Name",
            "title":"Company Login Name"
        }
    },
    "title":"Company details",
    "description":"User Company details. Applicable only for Users Across Companies"
}

Nested Schema : Currency

Type: object

Title: Currency

Currency preference of user. Value holds currency code

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: string
  Title: Value

  Value

{
    "type":"object",
    "description":"Currency preference of user. Value holds currency code",
    "title":"Currency",
    "properties":{
        "value":{
            "$ref":"#/definitions/value"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Date Format

Type: object

Title: Date Format

User preferred date time format

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value

{
    "type":"object",
    "description":"User preferred date time format",
    "title":"Date Format",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Groups

Type: object

Title: Groups

Groups to which the user belongs

Show Source

• items: array items

{
    "type":"object",
    "description":"Groups to which the user belongs",
    "title":"Groups",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/group"
            }
        }
    }
}

Nested Schema : Language

Type: object

Title: Language

Language preference of user. Value holds language code

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: string
  Title: Value

  Value

{
    "type":"object",
    "description":"Language preference of user. Value holds language code",
    "title":"Language",
    "properties":{
        "value":{
            "$ref":"#/definitions/value"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Links to the related objects

Type: array

Title: Links to the related objects

Links to the related objects

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links to the related objects",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : Number Format

Type: object

Title: Number Format

Preferred number format of user

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value

{
    "type":"object",
    "description":"Preferred number format of user",
    "title":"Number Format",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : TimeZone of user

Type: object

Title: TimeZone of user

User preferred timezone

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value

{
    "type":"object",
    "description":"User preferred timezone",
    "title":"TimeZone of user",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Type

Type: object

Title: Type

Type of the user

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: string
  Title: Value

  Value

{
    "type":"object",
    "description":"Type of the user",
    "title":"Type",
    "properties":{
        "value":{
            "$ref":"#/definitions/value"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Units

Type: object

Title: Units

User preferred units

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value

{
    "type":"object",
    "description":"User preferred units",
    "title":"Units",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Group
  Title: Group

  User group information

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/group"
    }
}

Nested Schema : Group

Type: object

Title: Group

User group information

Show Source

• label: string
  Title: Group Name

  Group name
• type: string
  Title: Group Type

  Type of the group
• variableName: string
  Title: Group Variable Name

  Variable name of the group

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "description":"Group name",
            "title":"Group Name"
        },
        "variableName":{
            "type":"string",
            "description":"Variable name of the group",
            "title":"Group Variable Name"
        },
        "type":{
            "type":"string",
            "description":"Type of the group",
            "title":"Group Type"
        }
    },
    "title":"Group",
    "description":"User group information"
}

Nested Schema : reference links

Type: object

Title: reference links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: URL to the related object

  URL to the related object
• rel: string
  Title: Link Relationship to the current object

  Default Value: self

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object",
            "default":"self"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top

Examples

The following example shows how to retrieve a list of integration users across all companies as JSON by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET  -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/cpq/rest/v19/integrationUsers

Response Body Sample

{
  "items": [{
      "login": "_custom_user_6ab1180a3cce465983d1c000144b6f1b",
      "isNotifyFax": false,
      "isNotifyEmail": true,
      "isUserAdminPermEnabled": false,
      "isApplicationAdminPermEnabled": false,
      "isWebServicesOnly": true,
      "isAccessAdminPermEnabled": false,
      "isProxyPermEnabled": false,
      "partyId": 181556695830934950,
      "partyNumber": "BM_Zb69fNkzcp8",
      "dateModified": "2025-09-26T12:17:59.000Z",
      "dateAdded": "2025-09-26T12:17:59.000Z",
      "links": [{
          "rel": "self",
          "href": "http://sitename.oracle.com/cpq/rest/v19/users/BM_Zb69fNkzcp8"
        }, {
          "rel": "child",
          "href": "http://sitename.oracle.com/cpq/rest/v19/users/BM_Zb69fNkzcp8/groups"
        }
      ],
      "lastLogin": "2025-09-26T12:18:55.000Z",
      "type": {
        "value": "FULL_ACCESS",
        "displayValue": "FullAccess"
      },
      "language": {
        "value": "en_US",
        "displayValue": "English"
      },
      "currency": {
        "value": "USD",
        "displayValue": "US Dollar"
      },
      "numberFormat": {
        "value": 0,
        "displayValue": "####.##"
      },
      "timeZone": {
        "value": "America/Chicago",
        "displayValue": "(GMT-6:00 GMT-5:00) Chicago"
      },
      "units": {
        "value": 1,
        "displayValue": "English"
      },
      "dateFormat": {
        "value": 0,
        "displayValue": "MM/dd/yyyy h:mm a"
      },
      "status": {
        "value": 1,
        "displayValue": "Active"
      },
      "oauthClientId": "6ab1180a3cce465983d1c000144b6f1b",
      "company": {
        "name": "cpq-mdb",
        "loginName": "_host"
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 34,
  "hasMore": false,
  "links": [{
      "rel": "canonical",
      "href": "http://sitename.oracle.com/cpq/rest/v19/users"
    }, {
      "rel": "self",
      "href": "http://sitename.oracle.com/cpq/rest/v19/users?offset=0&limit=1000"
    }
  ]
}

Back to Top