Users

Users

Search users

get

Searches users using structured query syntax. Supports field-level filtering with operators.

Authorizations

api-key & customer-api-authorizer

x-api-keystringRequired

API Gateway API key. Include as 'x-api-key: {key}' header.

AuthorizationstringRequired

AWS Cognito JWT token. Include as 'Authorization: Bearer {token}' header.

Query parameters

qstringOptional

limitinteger · int32 · min: 1 · max: 100OptionalDefault: 50

offsetinteger · int32 · max: 2147483647OptionalDefault: 0

Responses

200

Search results.

application/json

correlationIdstring · nullableOptional

timestampstring · date-timeOptional

400

Invalid query.

application/json

500

Internal server error.

application/json

get

/users/search

HTTPcURLJavaScriptPython

GET /customer/users/search HTTP/1.1
Host: api.partssource.com
x-api-key: YOUR_API_KEY
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "users": [
      {
        "contactId": 3000001,
        "loginUserId": "jsmith",
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Smith",
        "companies": []
      },
      {
        "contactId": 3000002,
        "loginUserId": "jdoe",
        "email": "[email protected]",
        "firstName": "Jane",
        "lastName": "Doe",
        "companies": []
      }
    ],
    "pagination": {
      "total": 42,
      "limit": 25,
      "offset": 0,
      "hasMore": true
    }
  },
  "correlationId": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": "2025-01-15T10:30:00.000Z"
}

Deprecated

Search users (deprecated)

post

Deprecated: Use GET /users or GET /users/search instead. Returns a paginated list of users matching the supplied criteria.

Authorizations

api-key & customer-api-authorizer

x-api-keystringRequired

API Gateway API key. Include as 'x-api-key: {key}' header.

AuthorizationstringRequired

AWS Cognito JWT token. Include as 'Authorization: Bearer {token}' header.

Query parameters

qstringOptional

Optional structured query string. When provided, body filters are ignored.

Body

application/jsontext/jsonapplication/*+json

Responses

200

Search results.

application/json

correlationIdstring · nullableOptional

timestampstring · date-timeOptional

400

Validation errors.

application/json

500

Internal server error.

application/json

post

/users/search

HTTPcURLJavaScriptPython

POST /customer/users/search HTTP/1.1
Host: api.partssource.com
x-api-key: YOUR_API_KEY
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "filters": {
    "email": "[email protected]",
    "emailContains": null,
    "firstName": "John",
    "lastName": "Smith"
  },
  "pagination": {
    "sortBy": "LastName",
    "sortDir": "Asc",
    "limit": 25,
    "offset": 0
  }
}

application/jsontext/jsonapplication/*+json

{
  "data": {
    "users": [
      {
        "contactId": 3000001,
        "loginUserId": "jsmith",
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Smith",
        "companies": []
      },
      {
        "contactId": 3000002,
        "loginUserId": "jdoe",
        "email": "[email protected]",
        "firstName": "Jane",
        "lastName": "Doe",
        "companies": []
      }
    ],
    "pagination": {
      "total": 42,
      "limit": 25,
      "offset": 0,
      "hasMore": true
    }
  },
  "correlationId": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": "2025-01-15T10:30:00.000Z"
}

Lookup user by ID or username

get

Retrieves a single user profile using CONTACT_ID (userId) or LOGIN_USER_ID (userName).

Authorizations

api-key & customer-api-authorizer

x-api-keystringRequired

API Gateway API key. Include as 'x-api-key: {key}' header.

AuthorizationstringRequired

AWS Cognito JWT token. Include as 'Authorization: Bearer {token}' header.

Query parameters

userIdstringOptional

Unique CONTACT_ID value assigned to the user.

userNamestringOptional

LOGIN_USER_ID associated with the user.

Responses

200

User located successfully.

application/json

correlationIdstring · nullableOptional

timestampstring · date-timeOptional

400

Invalid lookup parameters.

application/json

404

User not found.

application/json

get

/users/lookup

HTTPcURLJavaScriptPython

GET /customer/users/lookup HTTP/1.1
Host: api.partssource.com
x-api-key: YOUR_API_KEY
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "user": {
      "contactId": 3000001,
      "loginUserId": "jsmith",
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Smith",
      "companies": [
        {
          "id": 1000001,
          "name": "Acme Corporation",
          "shippingAddresses": [
            {
              "id": 4000001,
              "line1": "123 Main Street",
              "line2": "Suite 100",
              "city": "Springfield",
              "state": "IL",
              "zip": "62701"
            }
          ],
          "billingAddresses": [
            {
              "id": 5000001,
              "line1": "456 Corporate Blvd",
              "line2": null,
              "city": "Chicago",
              "state": "IL",
              "zip": "60601"
            }
          ]
        }
      ]
    }
  },
  "correlationId": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": "2025-01-15T10:30:00.000Z"
}