List Contract Customers Using GET

List Contract Customers Using GET

Get a list of customers of the contract. Supported selectors: customerNumber, name.

Pre-authorized roles: Operations, Read Only

Request
URI
GET
https://{api_host}//vcp.vmware.com/api/provider/v1/contracts/{contractId}/customers
COPY
Path Parameters
string
contractId
Required

Contract id

contractId example
630c2f68-xxxx-xxxx-xxxx-61f8245eaca1
Query Parameters
string
filter
Optional

FIQL format

integer
limit
Optional

limit

integer
offset
Optional

offset

string
sort
Optional

sort


Responses
200

OK

Returns PageOfBriefCustomer of type(s) application/json
{
    "content": [
        {
            "id": "c7240730-xxxx-xxxx-xxxx-250300000003",
            "customerNumber": 1000000001,
            "name": "Steven",
            "address1": "SW Ste 212 Manhattan DC",
            "address2": "1250 Canal Street Ave SW",
            "countryRegion": "US",
            "city": "New York",
            "state": "NY",
            "postalCode": 10041
        }
    ],
    "total": 1
}
content
Optional

content

integer As int64 As int64
total
Optional

total


400

Bad Request

Operation doesn't return any data structure

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure