Customers

Search customers by name

List or search customers. Used by the budget export scenario to resolve a customer name to a Plunet identifier before calling /V1/orders.

get/V1/customers

Request

Base URL
https://api.worders.net
Auth
- API key in cookie _worders_session
- or HTTP bearer
TypeScript
https://skmtc.dev/worders/apis/worders-api-v1/docs/V1/customers/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

qstring

Partial name match (case-insensitive). Empty returns all customers.

Response

matching customers

Example response

{
  "data": [
    {
      "id": 12345,
      "name": "AcmeCorp"
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.