Get the currently authenticated member

GET

/api/v5/member

Production

Returns the member account tied to the API key, including company and contact details, address, credit limit, available credit and charge terms. Requires an API key.

Responses

200

Member response

object

required

Member identifier.

number

company_name

required

Member company/business name.

string

nullable

contact_name

required

Primary contact name for the member.

string

nullable

address

required

Member street address.

string

nullable

suburb

required

Member suburb.

string

nullable

postcode

required

Member 4-digit AU postcode.

number

state

required

Member state code (e.g. NSW, VIC).

string

nullable

phone

required

Member contact phone number.

string

nullable

discount_factor

required

Multiplier applied to base rates for this member (1 = no discount).

number

credit_limit

required

Total account credit limit in AUD.

number

credit_limit_available

required

Remaining available credit in AUD.

number

charge_type

required

Billing arrangement, e.g. prepaid or account/credit.

string

nullable

last_invoice_timestamp

required

Any of:

string

terms

required

Any of:

string

active

required

Any of:

string

401

Missing or invalid API key

object

error

required

Human-readable error message describing why the request failed.

string

404

No member matched the API key

object

error

required

Human-readable error message describing why the request failed.

string