action onsched_get_consumer_v1_customers { label: "List Customers" description: "
Use this endpoint to return a List of Customers. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.
" provider: onsched method: GET path: "/consumer/v1/customers" encoding: json input: { type: "object" properties: { deleted: { type: "boolean" } email: { type: "string" } groupId: { type: "string" } lastname: { type: "string" } limit: { type: "integer" format: "int32" } locationId: { type: "string" } offset: { type: "integer" format: "int32" } } additionalProperties: false } output: { type: "object" properties: { count: { type: "integer" format: "int32" } data: { type: "array" items: { type: "object" properties: { address: { type: "object" properties: { addressLine1: { type: "string" } addressLine2: { type: "string" } city: { type: "string" } country: { type: "string" } postalCode: { type: "string" } state: { type: "string" } } additionalProperties: false } birthdate: { type: "string" } businessName: { type: "string" } companyName: { type: "string" } contact: { type: "object" properties: { businessPhone: { type: "string" } businessPhoneExt: { type: "string" } conferenceInfo: { type: "string" } homePhone: { type: "string" } mobilePhone: { type: "string" } phoneType: { type: "string" } skypeUsername: { type: "string" } } additionalProperties: false } createdBy: { type: "string" } createdOn: { type: "string" } customFields: { type: "object" } deletedStatus: { type: "boolean" } deletedTime: { type: "string" } disabled: { type: "boolean" } email: { type: "string" } emailInfo: { type: "boolean" } emailPromotion: { type: "boolean" } firstname: { type: "string" } gender: { type: "string" } groupId: { type: "string" } id: { type: "string" } inviteEmailSent: { type: "string" } lastVisitDate: { type: "string" } lastname: { type: "string" } latitude: { type: "string" } locationId: { type: "string" } longitude: { type: "string" } modifiedBy: { type: "string" } modifiedOn: { type: "string" } name: { type: "string" } notificationType: { type: "string" } object: { type: "string" } registeredBy: { type: "string" } registrationDate: { type: "string" } resourceId: { type: "string" } stripeCustomerId: { type: "string" } subscriptionId: { type: "string" } verificationDate: { type: "string" } verifiedBy: { type: "string" } welcomeEmailSent: { type: "string" } } additionalProperties: false } } hasMore: { type: "boolean" } object: { type: "string" } total: { type: "integer" format: "int32" } url: { type: "string" } } additionalProperties: false } }