REST API Services for Oracle CPQ

Get Sales Company Users

get

/rest/v16/salesCompanies/{companyLogin}/users

Use this endpoint to retrieve a list of users for the specified company login name.

Request

Path Parameters

companyLogin(required): string

The unique variable name to identify the company

Response

200 Response

The sales users for the company retrieved successfully

Root Schema : SalesUserCollectionModelResponse

Type: object

Show Source

count: integer
hasMore: boolean

Default Value: false
items: array items
limit: integer
links: array links
offset: integer
totalResutls: integer

{
    "type":"object",
    "properties":{
        "limit":{
            "type":"integer"
        },
        "offset":{
            "type":"integer"
        },
        "totalResutls":{
            "type":"integer"
        },
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/salesUserItem"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object salesUserItem

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

Nested Schema : links

Type: array

Show Source

Array of: object reference links

Title: reference links

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

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

Nested Schema : salesUserItem

Type: object

Show Source

dateAdded: string

Example: 2008-05-03T15:29:35.000Z
dateModified: string

Example: 2008-05-03T15:29:35.000Z
email: string

Example: kevin@partnerOrg.com
firstName: string

Example: Kevin
lastName: string

Example: Peterson
links: array links
login: string

Example: user1234
userKey: string

Example: sssss-fffff-3333-aaa

{
    "type":"object",
    "properties":{
        "login":{
            "type":"string",
            "example":"user1234"
        },
        "firstName":{
            "type":"string",
            "example":"Kevin"
        },
        "lastName":{
            "type":"string",
            "example":"Peterson"
        },
        "userKey":{
            "type":"string",
            "example":"sssss-fffff-3333-aaa"
        },
        "email":{
            "type":"string",
            "example":"kevin@partnerOrg.com"
        },
        "dateAdded":{
            "type":"string",
            "example":"2008-05-03T15:29:35.000Z"
        },
        "dateModified":{
            "type":"string",
            "example":"2008-05-03T15:29:35.000Z"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object reference links

Title: reference links

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

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

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
name: string
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"
        },
        "name":{
            "type":"string"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

403 Response

User has no access to the company resource

404 Response

The company resource not found

Examples

The following example shows how to retrieve a list of users for the specified company login name by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users

Response Body Sample

{
  "items": [{
      "login": "FA_date4",
      "firstName": "duncin",
      "lastName": "salesagent",
      "userKey": "d453a7df-b6d1-4dbf-8ebe-9507e0740d16",
      "email": "junk@bigmachines.com",
      "dateAdded": "2011-02-09T22:55:11.000Z",
      "dateModified": "2024-05-14T04:19:16.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users/FA_date4"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users"
        }
      ]
    }, {
      "login": "QA_BA_FA1",
      "firstName": "TestUser",
      "lastName": "NameMy",
      "userKey": "14767e4a-7aa0-4be9-93b0-b0663c6c3cfd",
      "email": "junk@bigmachines.com",
      "dateAdded": "2011-02-09T22:44:33.000Z",
      "dateModified": "2024-05-14T04:19:12.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users/QA_BA_FA1"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users"
        }
      ]
    }, {
      "login": "SA_EURO_Number2",
      "firstName": "Test",
      "lastName": "Euro",
      "userKey": "4bc2c2ab-474a-4a2e-8871-ebdfdbc8c129",
      "email": "junk@bigmachines.com",
      "dateAdded": "2011-02-09T23:05:43.000Z",
      "dateModified": "2024-05-14T04:19:12.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users/SA_EURO_Number2"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users"
        }
      ]
    }, {
      "login": "SA_EURO_Number3",
      "firstName": "Test",
      "lastName": "Euro",
      "userKey": "4b02c5f4-31ce-4021-8ea7-61274834a1e4",
      "email": "junk@bigmachines.com",
      "dateAdded": "2011-02-09T23:08:05.000Z",
      "dateModified": "2024-05-14T04:19:11.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users/SA_EURO_Number3"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users"
        }
      ]
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 4,
  "hasMore": false,
  "links": [{
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM"
    }, {
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users?offset=0&limit=1000"
    }
  ]
}