Search Sales Reps

Use this endpoint to search for sales reps via a keyword

REST Endpoint

GET /restapi/v1/users/searchSalesReps?keyword=:searchKeyword

Query Parameter

keyword=:searchKeyword

Response Status Code

200 OK

Response Content Type

application/json

Response JSON Example

{
    "salesReps": [
        {
            "sourceCode": "123/exampleRep",
            "email": "examplerep@usps.gov",
            "displayName": "Example Rep"
        },
        {
            "sourceCode": "123/mikejones",
            "email": "mike.jones@usps.gov",
            "displayName": "Mike Jones"
        }
    ]
}

Explanation of Response

The salesRep array is an array of objects. Each object in the salesRep array corresponds to a user that matches on the keyword search, and contains a sourceCode, email, and displayName of the user. The salesRep array will be an empty array if no users are found for the keyword.