Home

Download this help site
(PDF 82MB)

Download

Tenders API V2 call

Icon

Wild Apricot's API is intended for use by developers with technical expertise. If you need assistance, we provide support via email or through our Developers forum.

You can use the Tenders API call to retrieve information about tenders – the methods by which payments are received. You can retrieve information about a particular tender or about all tenders within the specified account.

Retrieving information for a particular tender

Syntax

Example

Retrieving information for all tenders

Syntax

Example

Icon

Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see Authenticating API access from a 3rd-party server or application or Authenticating API access from a Wild Apricot site page.

Parameters

The following parameters are used within the Tenders API call:

Variable

Description

{baseAPIaddress}

The base address of the API. For more information, see API access options.

{accountID}

The account identifier that appears on the Account and billing screen and is returned by the Accounts API call .

{tenderID}The unique identifier of the tender. Tender IDs are returned by the Tenders API call.

Response fields

For each tender, the Tenders API call retrieves the following information.

Field

Description

DisplayPositionThe position of the tender within the tenders list.
IsCustomIndicates whether the tender was created by an administrator.
IDThe unique identifier of the tender.
URLThe address of the API call for this tender.
NameThe name assigned to the tender.

Sample JSON response

 Click here to expand/collapse

Sample XML response

 Click here to expand/collapse

On this page:   

See also:

  • No labels