Table of Contents
- API Usage Guide
- API Command Reference
- add_booking
- add_client
- add_invoice
- add_resource
- approve_request
- authenticate_user
- del_booking
- del_bookings
- del_client
- del_invoice
- del_resource
- email_client
- gen_invoice
- get_activity
- get_availability
- get_booking
- get_booking_type
- get_booking_types
- get_bookings
- get_client
- get_consumable_levels
- get_invoice
- get_invoices
- get_messages
- get_reminders
- get_resource
- get_resource_availability
- get_setting
- get_template
- get_user
- get_users_logged_in
- get_venue
- get_venue_groups
- get_venues
- get_venues_in_group
- get_venues_in_use
- get_watches
- mod_booking
- mod_client
- mod_invoice
- mod_resource
- mod_venue
- notify_user
- reject_request
- restore_booking
- set_setting
- set_template
- util_api_usage
- util_from_epoch
- util_to_epoch
- Appendix A - Activity Codes
- Appendix B - Setting Names
- Appendix C - Error Handling
- Code Samples
- Troubleshooting
- Release Notes
← Hide Table of Contents
MIDAS API: get_client
MIDAS API: get_client
Returns client records
| Required Parameters (at least 1 required) | Possible Values | Description |
| client | Client name | Client Name |
| org | Organization name | Organization name |
| email address | Email address |
| Optional Parameters | Possible Values | Description |
| match | exact | loose | Allows specifying the closeness of the match. If match is set "exact" and "client" is set to "Joe Bloggs", only clients with the name "Joe Bloggs" will be returned. If match is set to "loose" and "email" is set to "@mid.as", any client with an "@mid.as" email address will be returned. If the match parameter is omitted only exact matches are returned |
| Example Response ↓ Show |
[
{
"id":"23",
"name":"Joe Bloggs",
"organization":"MIDAS",
"email":"[email protected]",
"address":"PO Box 224,Cheadle,Cheshire.SK8 4WB",
"phone":"01234 567 890",
"fax":"01234 567 891",
"mobile":"07123456789",
"notes":"",
"tax_exempt":"0",
"credit":"22.50",
"added":"7/8/2012 @ 16:49"
}
] |
| Variables Returned | Description |
| id | Unique client identification number (NOTE: in API 2.07 and earlier this variable was instead named "client_id") |
| name | Client's name |
| organization | Client's organization |
| Client's email address | |
| address | Client's postal address |
| phone | Client's telephone number |
| fax | Client's fax number |
| mobile | Client's mobile (cell) number |
| notes | Notes about the client |
| tax_exempt | Is the client exempt from tax being applied to their invoices? |
| credit | [MIDAS v4.12+] Client's current credit |
| added | Date/time when client was added to MIDAS |