API docs by Redocly

Felix API (1.0.0)

Download OpenAPI specification:Download

Introduction

The Felix REST API is an interface that provides access to system data and enables you to interact with Felix programmatically. All Felix API methods are organised in a RESTful way, use JSON to encode objects and rely on the standard HTTP codes to communicate operation outcomes.

This document provides an overview of available endpoints within Vendor Management and Sourcing Modules of the Felix REST API.

API Host URL

The base URL for all requests to the Felix API is https://api.felix.net/v1.

Authentication

The Felix API uses Bearer Tokens to authenticate requests. You can view and manage your Bearer Tokens in your Felix account.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

Responses / Errors

Error type

authentication_error - Failed to authenticate, usually the token is incorrect.

Response statuses

Code Meaning Description
200 Success If data was requested, it will be available in the data field at the top level of the response body.
201 Created Its information is available in the data field at the top level of the response body.
The API URL where the object can be retrieved is also returned in the Location header of the response.
403 Forbidden The authentication and request syntax was valid but the server is refusing to complete the request.
This can happen if you try to read or write to objects or properties that the user does not have access to.
404 Not Found Either the request method and path supplied do not specify a known action in the API,
or the object specified by the request does not exist.

Vendors

List all vendors

This method will list all the vendors. There is a limit of 1000 returned per page.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

last_updated
string
Example: last_updated=2020-02-10T22:08:19Z

Only show vendors updated since the provided time. Time is always assumed to be UTC

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve a vendor

Retrieve a vendor

path Parameters
vendorId
required
integer

Numeric ID of the vendor

Responses

Response samples

Content type
application/json
{
  • "id": 7846,
  • "global_vendor_id": 6578,
  • "registered_business_name": "Derek's Digging",
  • "legal_entity_name": "Derek's Digging Pty Ltd",
  • "abn": "222444666",
  • "business_number": "333555777",
  • "country_title": "Australia",
  • "contact_name": "Peter Allen",
  • "contact_phone": "0412345678",
  • "formatted_address": "string",
  • "extra_address_line": "string",
  • "address_city": "Sydney",
  • "address_line1": "200 Pitt Street",
  • "address_state": "New South Wales",
  • "address_postcode": "4000",
  • "supplier_phone": "0412345678",
  • "last_updated": "2020-02-10T22:08:19Z",
  • "status": "string",
  • "panel_memberships": [
    ],
  • "external_references": [
    ],
  • "registration_information": {
    },
  • "key_contact": {
    },
  • "performance_score": 99.9,
  • "invited_by": {
    }
}

Suspend a vendor

Suspend a vendor that is currently Approved and not suspended.

path Parameters
vendorId
required
integer

Numeric ID of the vendor

Request Body schema: application/json
comment
string

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Unsuspend a vendor

Unsuspend a vendor that is currently Approved and suspended.

path Parameters
vendorId
required
integer

Numeric ID of the vendor

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Compliance Questionnaire

List of responses

List of responses

path Parameters
vendorId
required
integer

Numeric ID of the vendor

Responses

Response samples

Content type
application/json
{
  • "sections": [
    ]
}

Items

List of items

List of items

path Parameters
vendorId
required
integer

Numeric ID of the vendor

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Compliance Documents

List of documents

List of compliance documents

path Parameters
vendorId
required
integer

Numeric ID of the vendor

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

validation
string
Enum: "validated" "declined" "pending"

Status of the document

status
string
Enum: "active" "archived" "replaced"

Status of the document

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Tags

List all tags

Retrieve a list of all the available tags. These can then be assigned or removed from vendors.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

List attached tags

List attached tags

path Parameters
vendorId
required
integer

Numeric ID of the vendor

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Attach a tag

Attach a tag to a vendor

path Parameters
vendorId
required
integer

Numeric ID of the vendor

Request Body schema: application/json
tag_id
integer
comment
string

Responses

Request samples

Content type
application/json
{
  • "tag_id": 0,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "vendor_id": 0,
  • "tag_id": 0,
  • "tag_name": "string",
  • "comment": "string",
  • "created_at": "string",
  • "updated_at": "string"
}

Update a tag

Update an attached tag

path Parameters
vendorId
required
integer

Numeric ID of the vendor

attachedTagId
required
integer

Numeric ID of the attached tag

Request Body schema: application/json
comment
string

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "vendor_id": 0,
  • "tag_id": 0,
  • "tag_name": "string",
  • "comment": "string",
  • "created_at": "string",
  • "updated_at": "string"
}

Detach a tag

Detach a tag

path Parameters
vendorId
required
integer

Numeric ID of the vendor

attachedTagId
required
integer

Numeric ID of the attached tag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

External References

List reference types

List all external reference types

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

List references

List external references

path Parameters
vendorId
required
integer

Numeric ID of the vendor

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Create a reference

Create an external reference

path Parameters
vendorId
required
integer

Numeric ID of the vendor

Request Body schema: application/json
external_reference_type_id
integer
external_reference
string

Responses

Request samples

Content type
application/json
{
  • "external_reference_type_id": 0,
  • "external_reference": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_reference_type_id": 0,
  • "external_reference_type_title": "string",
  • "entity_id": 0,
  • "external_reference": "string",
  • "created_at": "string",
  • "created_by": 0,
  • "enabled": 0,
  • "synced_at": "string"
}

Delete a reference

Delete an external reference

path Parameters
vendorId
required
integer

Numeric ID of the vendor

externalReferenceId
required
integer

Numeric ID of the external reference

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Payment Details

List payment details

This method returns a list of all payment details for a chosen vendor

path Parameters
vendorId
required
integer

Numeric ID of the vendor

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

status
integer
Enum: 1 2 3

Status of the payment detail record, where 1 = Pending validation/approval, 2 = Approved/validated, 3 = Review (needs vendor review, was declined in current form)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Vendor Branches

List all Branches

Returns a list of a vendor’s branches

Deleted branches are not returned. Has a limit of 250 per page.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page.

Defaults to 25. Limited to 250.

updated_at_min
string

Show branches updated at or after a date

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Branch Payment Details

List all Branch Payment Details

Returns the link between a Branch and the corresponding Payment Details for that Branch.

Branches and Payment details are created and managed by Vendors, including the link between the two.

Deleted branches are not returned. Has a limit of 250 per page.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page.

Defaults to 25. Limited to 250.

updated_at_min
string

Show records updated at or after a date.

Example: updated_at_min=2024-02-10T22:08:19Z (all times are in UTC)

payment_details_id
string

Show records relating to a specific set of Payment Details.

branch_id
string

Show records relating to a specific Branch.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Projects

List all projects

This method returns a brief description of all projects in the current organisation. Limit up to 1000 per page.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

projectStatus
string
Example: projectStatus=In Progress

Project Status

projectStatusId
integer
Example: projectStatusId=1

Project Status Id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve a project

This method returns details of an individual folder.

path Parameters
projectId
required
integer

Numeric ID of the project

Responses

Response samples

Content type
application/json
{
  • "id": 1234,
  • "title": "Some Title",
  • "status": {
    },
  • "fields": [
    ],
  • "created_at": "2020-02-10T22:08:19Z",
  • "created_by": {
    },
  • "updated_at": "2020-02-10T22:08:19Z",
  • "updated_by": {
    },
  • "access_type": "No Restriction"
}

List all project statuses

This method returns project statuses for the current organisation.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Project Folders

List all project folders

This method returns a brief description of project folders in the current organisation. Limit up to 1000 per page.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

projectId
integer
Example: projectId=1

Project Id

includeArchived
integer
Example: includeArchived=1

By default, it returns only un-archived project folders. If 1, it will return both un-archived and archived project folders.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve a project folder

This method returns details of an individual folder.

path Parameters
folderId
required
integer

Numeric ID of the project folder

Responses

Response samples

Content type
application/json
{
  • "id": 7846,
  • "title": "Some Project Title",
  • "project_id": 1243,
  • "archived": true,
  • "created_at": "2020-02-10T22:08:19Z",
  • "created_by": {
    },
  • "updated_at": "2020-02-10T22:08:19Z",
  • "updated_by": {
    }
}

Sourcing Requests

List all sourcing requests

This method will list all the sourcing requests. There is a limit of 1000 returned per page. Response will include “is_sealed”: true for requests where sealed bidding is enabled for the project and the close date for the event as not yet passed. These sealed requests will return limited information in more detailed API calls until the event close date has passed. recipients_responded returns number of vendors that have responded to a Sourcing Request (any Item). In the case of Sourcing Request Items with pricing schedules - responses are recorded no matter which version of a pricing schedule they first responded to.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

projectFolderId
integer
Example: projectFolderId=1

Only show sourcing requests that match with project folder id

requestStatus
string
Enum: "Open" "Saved" "Closed"
Example: requestStatus=Open

Only show sourcing requests that match with request status

requestResult
string
Enum: "Pending" "Awarded"
Example: requestResult=Pending

Only show sourcing requests that match with request result

hasResponses
integer
Enum: 0 1
Example: hasResponses=1

1 - return sourcing requests that has at least one response. 0 - return sourcing requests that do not have any responses. Will include responses to any version of a pricing schedule, not just the latest issued by an organisation.

includeArchived
integer
Example: includeArchived=1

1 - return sourcing requests including archived (both archived and un-archived) by default - only return un-archived requests

responsesLessThan
integer
Example: responsesLessThan=3

return sourcing requests with responses less than the given parameter. Will include responses to any version of a pricing schedule, not just the latest issued by an organisation.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve a sourcing request

Retrieve a sourcing request. Response will include “is_sealed”: true for a request where sealed bidding is enabled for the project and the close date for the event as not yet passed. These sealed requests will return limited information in more detailed API calls until the event close date has passed. recipients_responded returns number of vendors that have responded to a Sourcing Request (any Item). In the case of Sourcing Request Items with pricing schedules - responses are recorded no matter which version of a pricing schedule they first responded to.

path Parameters
requestId
required
integer

Numeric ID of the sourcing request

Responses

Response samples

Content type
application/json
{
  • "id": 1234,
  • "title": "Some Title",
  • "project": {
    },
  • "project_folder": {
    },
  • "status": "Open",
  • "result": "Pending",
  • "location_extra_details": "Pending",
  • "location": "HENDRA, QLD, 4011",
  • "country": "Australia",
  • "close_date": "2020-02-10T22:08:19Z",
  • "sent_at": "2020-02-10T22:08:19Z",
  • "comments": "comments example",
  • "show_contact": true,
  • "parent_id": 1,
  • "created_at": "2020-02-10T22:08:19Z",
  • "created_by": {
    },
  • "job_start_date": "2020-02-10T22:08:19Z",
  • "job_end_date": "2020-02-10T22:08:19Z",
  • "quote_type": "Tender",
  • "work_type": "Commercial",
  • "close_date_setting": "RFQ Close Date",
  • "archived": true,
  • "recipients": 4,
  • "recipients_responded": 2,
  • "owner": {
    },
  • "is_sealed": false
}

List all sourcing requests for a project

This method will list all the sourcing requests for the given project. There is a limit of 1000 returned per page. Response will include “is_sealed”: true for requests where sealed bidding is enabled for the project and the close date for the event as not yet passed. These sealed requests will return limited information in more detailed API calls until the event close date has passed. recipients_responded returns number of vendors that have responded to a Sourcing Request (any Item). In the case of Sourcing Request Items with pricing schedules - responses are recorded no matter which version of a pricing schedule they first responded to.

path Parameters
projectId
required
integer

Numeric ID of a project

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

projectFolderId
integer
Example: projectFolderId=1

Only show sourcing requests that match with project folder id

requestStatus
string
Enum: "Open" "Saved" "Closed"
Example: requestStatus=Open

Only show sourcing requests that match with request status

requestResult
string
Enum: "Pending" "Awarded"
Example: requestResult=Pending

Only show sourcing requests that match with request result

hasResponses
integer
Enum: 0 1
Example: hasResponses=1

1 - return sourcing requests that has at least one response. 0 - return sourcing requests that do not have any responses. Will include responses to any version of a pricing schedule, not just the latest issued by an organisation.

includeArchived
integer
Example: includeArchived=1

1 - return sourcing requests including archived (both archived and un-archived) by default - only return un-archived requests

responsesLessThan
integer
Example: responsesLessThan=3

return sourcing requests with responses less than the given parameter. Will include responses to any version of a pricing schedule, not just the latest issued by an organisation.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Sourcing Request Items

List all sourcing request items

Return a brief description of all sourcing request items in the current organisation. Responses (for response schema) include vendor responses to sourcing request items that were manually added by the organisation, and vendor responses no matter which pricing schedule version was responded to. The pricing_line_items object returns only the latest released pricing schedule version by the organisation.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

categoryTitle
string
Example: categoryTitle=Excavator

filter by category name, exact match

isSent
integer
Example: isSent=1

sent: 1, not sent: 0

includeArchivedRequests
integer
Example: includeArchivedRequests=1

1: include archived, otherwise: only un-archived

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

List request items for specific sourcing request

Return a brief description of sourcing request items for a specific RFQ. Responses (for response schema) include vendor responses to sourcing request items that were manually added by the organisation, and vendor responses no matter which pricing schedule version was responded to. The pricing_line_items object returns only the latest released pricing schedule version by the organisation.

path Parameters
requestId
integer
Example: 20384

sorcing request id

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

isSent
integer
Example: isSent=1

sent: 1, not sent: 0

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Get a request item

Return a brief description of a specific item. Responses (for response schema) include vendor responses to sourcing request items that were manually added by the organisation, and vendor responses no matter which pricing schedule version was responded to. The pricing_line_items object returns only the latest released pricing schedule version by the organisation.

path Parameters
requestId
integer
Example: 12345

Id of sorcing request

itemId
integer
Example: 12345

Id of sorcing request item

Responses

Response samples

Content type
application/json
{
  • "id": 7846,
  • "title": "1 x Tandem Tipper - Wet and dry quote",
  • "request": {
    },
  • "category": {
    },
  • "comments": "example comment",
  • "quantity": 3,
  • "budget": 1000,
  • "forecast_period": "2020-09-08T23:11:52.000000Z",
  • "current_forecast": 1229268,
  • "current_target": 1229268,
  • "close_date": "2020-09-08T23:11:52.000000Z",
  • "pricing_options": [
    ],
  • "pricing_line_items": { },
  • "is_sent": true,
  • "responses": 10
}

Pricing Schedule Line Items

List all line items

Return all line items for a specific organisation. Response schema will return ““ for value, quantity, exclusions, inclusions and comments where a sourcing request has boolean “is_sealed”: true (for requests where sealed bidding is enabled for the project and the close date for the event as not yet passed). Response schema will return vendor submitted values when close date has passed. Responses (for response schema) are the latest submitted values by vendors.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

projectId
integer
Example: projectId=20384

If of a project

includeUnsent
integer
Example: includeUnsent=1

By default, it returns for sent items If includeUnsent = 1, it will also include unsent items. "Unsent" refers to a Sourcing Request and not a pricing schedule version.

includeArchivedRequests
integer
Example: includeArchivedRequests=1

1: include archived, otherwise: only un-archived

lineItemTitle
string
Example: lineItemTitle=35T All Terrain

Title of line item. It will be included if the title contains the parameter. e.g. parameter "nana" title "banana" Will only query (search) the latest released pricing schedule version.

customIdentifier
string
Example: customIdentifier=EFG555966

Custom Identifier. Will only query (search) the latest released pricing schedule version.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

List all line items for an item within an RFQ

Return all line items for a specific item within an RFQ together with responses to it (if available). If the item is not sent, there can be no responses to it. Response schema will return ““ for value, quantity, exclusions, inclusions and comments where a sourcing request has boolean “is_sealed”: true (for requests where sealed bidding is enabled for the project and the close date for the event as not yet passed). Response schema will return vendor submitted values when close date has passed. Responses (for response schema) are the latest submitted values by vendors.

path Parameters
requestId
integer
Example: 20384

If of a request

itemId
integer
Example: 12345

Id of an item

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

lineItemTitle
string
Example: lineItemTitle=35T All Terrain

Title of line item. It will be included if the title contains the parameter. e.g. parameter "nana" title "banana" Will only query (search) the latest released pricing schedule version.

customIdentifier
string
Example: customIdentifier=EFG555966

Custom Identifier. Will only query (search) the latest released pricing schedule version.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Recipients

List all vendors that received a specific item

Return recipients filtered by a specific item. Response schema will return ““ for rejection_comment, comments, quantity, and pricing_option_responses where a sourcing request has boolean “is_sealed”: true (for requests where sealed bidding is enabled for the project and the close date for the event as not yet passed). Response schema will return vendor submitted values when close date has passed. Response (for response schema) are the latest submitted values by vendors where multiple pricing schedule versions have been issued.

path Parameters
requestId
integer
Example: 20384

Id of a request

itemId
integer
Example: 12345

Id of an item

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

responseStatus
string
Example: responseStatus=Quoted

Response statuses include: Quoted, Declined, Pending, Viewed, Manually Quoted, Manually Declined. Response status does not toggle based on a pricing schedule addendum being sent and existing quote not yet updated.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Get a recipient

Return an individual recipient together with their responses. Response schema will return ““ for rejection_comment, comments, quantity, and pricing_option_responses where a sourcing request has boolean “is_sealed”: true (for requests where sealed bidding is enabled for the project and the close date for the event as not yet passed). Response schema will return vendor submitted values when close date has passed. Response (for response schema) are the latest submitted values by vendors where multiple pricing schedule versions have been issued.

path Parameters
recipientId
integer
Example: 12345

Id of recipient

Responses

Response samples

Content type
application/json
{
  • "id": 334345,
  • "vendor_id": 343433,
  • "global_vendor_id": 34345,
  • "vendor_registered_business_name": "Test",
  • "request": {
    },
  • "status": "Quoted",
  • "rejection_comment": "Too far away",
  • "response": [
    ],
  • "is_manually_added": true,
  • "created_at": "2020-02-10T22:08:19Z"
}

Line Item Responses

List all responses to line items for an item within an RFQ

Return responses of all recipients to a pricing schedule that belongs to a specific item. Response schema will return ““ for rate, quantity_suggested, exclusions, inclusions and comments where a sourcing request has boolean “is_sealed”: true (for requests where sealed bidding is enabled for the project and the close date for the event as not yet passed). Response schema will return vendor submitted values when close date has passed. Responses (for response schema) are the latest submitted values by vendors, and only responses to the last version of a schedule issued by the organisation.

path Parameters
requestId
integer
Example: 20384

Id of a request

itemId
integer
Example: 12345

Id of an item

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Awards

List all awards

This method returns a brief description of awards in the current organisation. Limit up to 1000 per page.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

awardType
string
Enum: "engagement" "award" "variation"

Only show awards that match with the type (case insensitive)

awardStatus
string
Enum: "pending" "declined" "cancelled" "approval-saved" "approval-declined" "approval-not-started" "sent-for-approval" "pending-approval" "draft" "finalised" "awarded" "complete" "pending-vendor" "pending-client" "closed" "accepted" "approved"

Only show awards that match with the status (case insensitive). Statuses are related to the award type:

  • Engagement - statuses: Draft, Pending, Accepted, Declined, Complete, Closed, Cancelled.
  • Award & Variation (to Award) - statuses: Pending, Approval declined, Cancelled, Pending approval, Approval saved, Approval not started, Approved not awarded, Sent for approval, Finalised, Awarded
  • Variation (to Engagement) - statuses: Pending vendor, Pending client, Accepted, Approved, Declined.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

List all awards for a project

List all awards for a project

path Parameters
projectId
required
integer

Numeric ID of a project

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

awardType
string
Enum: "engagement" "award" "variation"

Only show awards that match with the type (case insensitive)

awardStatus
string
Enum: "pending" "declined" "cancelled" "approval-saved" "approval-declined" "approval-not-started" "sent-for-approval" "pending-approval" "draft" "finalised" "awarded" "complete" "pending-vendor" "pending-client" "closed" "accepted" "approved"

Only show awards that match with the status (case insensitive). Statuses are related to the award type:

  • Engagement - statuses: Draft, Pending, Accepted, Declined, Complete, Closed, Cancelled.
  • Award & Variation (to Award) - statuses: Pending, Approval declined, Cancelled, Pending approval, Approval saved, Approval not started, Approved not awarded, Sent for approval, Finalised, Awarded
  • Variation (to Engagement) - statuses: Pending vendor, Pending client, Accepted, Approved, Declined.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

List all awards for a sourcing request item

List all awards for a sourcing request item

path Parameters
itemId
required
integer

Numeric ID of a Sourcing Request Item

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

awardType
string
Enum: "engagement" "award" "variation"

Only show awards that match with the type (case insensitive)

awardStatus
string
Enum: "pending" "declined" "cancelled" "approval-saved" "approval-declined" "approval-not-started" "sent-for-approval" "pending-approval" "draft" "finalised" "awarded" "complete" "pending-vendor" "pending-client" "closed" "accepted" "approved"

Only show awards that match with the status (case insensitive). Statuses are related to the award type:

  • Engagement - statuses: Draft, Pending, Accepted, Declined, Complete, Closed, Cancelled.
  • Award & Variation (to Award) - statuses: Pending, Approval declined, Cancelled, Pending approval, Approval saved, Approval not started, Approved not awarded, Sent for approval, Finalised, Awarded
  • Variation (to Engagement) - statuses: Pending vendor, Pending client, Accepted, Approved, Declined.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve an award

Retrieve an award

path Parameters
awardId
required
integer

Numeric ID of the award

Responses

Response samples

Content type
application/json
{
  • "id": 7846,
  • "type": "Award",
  • "status": "Sent to approval",
  • "vendor_id": 6578,
  • "recipient_id": 6578,
  • "response_id": 6578,
  • "item_id": 6578,
  • "vendor_item_id": 6578,
  • "value": 6578,
  • "category": {
    },
  • "ref_number": "PO0893",
  • "variation_to_award_id": 6578,
  • "comments": "Derek's Digging Pty Ltd",
  • "start_date": "2020-02-10T22:08:19Z",
  • "end_date": "2020-02-10T22:08:19Z",
  • "created_at": "2020-02-10T22:08:19Z",
  • "created_by": {
    }
}

Procurement Schedule

Retrieve all project packages

This method returns all project packages.

path Parameters
projectId
required
integer

Numeric ID of the project

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page

last_updated
string
Example: last_updated=2021-09-23T11:52:00Z

Only show packages updated since the provided time. Time is always assumed to be UTC

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Users

List all users

Returns a list of all your users. Deleted users are not returned. Has a limit of 250 per page.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page.

Defaults to 25. Limited to 250.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve a user

This method returns details of an individual user.

path Parameters
userId
required
integer

The ID of the user

Responses

Response samples

Content type
application/json
{
  • "id": 7846,
  • "first_name": "John",
  • "last_name": "Doe",
  • "email": "example@test.com",
  • "secondary_email": "example@test.com",
  • "status": "active",
  • "phone": "0412345678",
  • "mobile_phone": "0412345678",
  • "last_logged_in_at": "2024-01-09T04:47:29.000000Z",
  • "created_at": "2024-01-09T04:47:29.000000Z",
  • "updated_at": "2024-01-09T04:47:29.000000Z"
}

Security Groups

List all security groups

Returns a list of all your security groups.

Deleted security groups are not returned. Has a limit of 250 per page.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page.

Defaults to 25. Limited to 250.

updated_at_min
string

Show security groups updated at or after a date

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

List all security group memberships

Returns a list of user memberships for security groups.

Deleted memberships are not returned. Has a limit of 250 per page.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page.

Defaults to 25. Limited to 250.

user
integer

Returns Security Group Memberships for the User ID provided

security_group
integer

Returns User members for the Security Group ID provided.

created_at_min
string

Show memberships created at or after a date

Example: created_at_min=2020-02-10T22:08:19Z (all times are in UTC)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Teams

List all Teams

Returns a list of all your Teams.

Deleted Teams are not returned. Has a limit of 500 per page.

query Parameters
page
integer

The page to be returned

per_page
integer

The number of results to show per page.

Defaults to 100. Limited to 500.

updated_at_min
string

Show Teams updated at or after a date.

This date is tracked from 2024-03-25, and older records will return that date.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}