Download OpenAPI specification:Download
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.
The base URL for all requests to the Felix API is https://api.felix.net/v1.
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.
authentication_error
- Failed to authenticate, usually the token is incorrect.
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. |
This method will list all the vendors. There is a limit of 1000 returned per page.
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 |
{- "data": [
- {
- "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": [
- {
- "panel_id": 0,
- "panel_title": "string",
- "status_id": 0,
- "status_title": "string",
- "created_at": "2020-02-10T22:08:19Z",
- "updated_at": "2020-02-10T22:08:19Z"
}
], - "external_references": [
- {
- "id": 0,
- "value": "string",
- "type_id": 0,
- "type_title": "string"
}
], - "registration_information": {
- "abn": "44600712589",
- "abn_status": "Active",
- "abn_status_date": "2014-07-15",
- "acn": "600712589",
- "legal_entity_name": "FELIX SOFTWARE PTY LTD",
- "entity_code": "PRV",
- "entity_type": "Australian Private Company",
- "gst_date": "2014-07-15",
- "main_postcode": "4005",
- "main_state": "QLD",
- "synced_at": "2023-02-17T06:54:54.000000Z"
}, - "key_contact": {
- "contact_name": "John Rutledge",
- "contact_email": "john.rutledge@armyspy.com",
- "contact_role": "Project Manager",
- "contact_mobile_phone": "+61491XXXXXX"
}, - "performance_score": 99.9,
- "invited_by": {
- "id": 95432672,
- "name": "Debra Steelman"
}
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
Retrieve a vendor
vendorId required | integer Numeric ID of the vendor |
{- "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": [
- {
- "panel_id": 0,
- "panel_title": "string",
- "status_id": 0,
- "status_title": "string",
- "created_at": "2020-02-10T22:08:19Z",
- "updated_at": "2020-02-10T22:08:19Z"
}
], - "external_references": [
- {
- "id": 0,
- "value": "string",
- "type_id": 0,
- "type_title": "string"
}
], - "registration_information": {
- "abn": "44600712589",
- "abn_status": "Active",
- "abn_status_date": "2014-07-15",
- "acn": "600712589",
- "legal_entity_name": "FELIX SOFTWARE PTY LTD",
- "entity_code": "PRV",
- "entity_type": "Australian Private Company",
- "gst_date": "2014-07-15",
- "main_postcode": "4005",
- "main_state": "QLD",
- "synced_at": "2023-02-17T06:54:54.000000Z"
}, - "key_contact": {
- "contact_name": "John Rutledge",
- "contact_email": "john.rutledge@armyspy.com",
- "contact_role": "Project Manager",
- "contact_mobile_phone": "+61491XXXXXX"
}, - "performance_score": 99.9,
- "invited_by": {
- "id": 95432672,
- "name": "Debra Steelman"
}
}
Suspend a vendor that is currently Approved and not suspended.
vendorId required | integer Numeric ID of the vendor |
comment | string |
{- "comment": "string"
}
{- "error": {
- "code": 422,
- "message": "Vendor is not approved."
}
}
List of responses
vendorId required | integer Numeric ID of the vendor |
{- "sections": [
- {
- "section_id": 0,
- "section_name": "string",
- "section_sort": 0,
- "section_fields": [
- {
- "field_id": 0,
- "field_name": "string",
- "field_label": "string",
- "field_type": "string",
- "field_sort": 0,
- "field_reviewer_tooltip": "string",
- "field_respondent_tooltip": "string",
- "field_response": {
- "value": "string",
- "created_at": "string",
- "file": {
- "file_id": 0,
- "filename": "string",
- "created_at": "string"
}
}
}
]
}
]
}
List of items
vendorId required | integer Numeric ID of the vendor |
page | integer The page to be returned |
per_page | integer The number of results to show per page |
{- "data": [
- {
- "id": 0,
- "vendor_id": 0,
- "global_vendor_id": 0,
- "title": "string",
- "status": 0,
- "category_id": 0,
- "category_title": "string",
- "panel_availability_count": 0,
- "panel_availability": [
- {
- "title": "string",
- "created_at": "string"
}
]
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
List of compliance documents
vendorId required | integer Numeric ID of the vendor |
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 |
{- "data": [
- {
- "id": 0,
- "title": "string",
- "status": "string",
- "validation": "string",
- "file": "string",
- "expiry_date": "string",
- "provider": "string",
- "classification": "string",
- "commencement_date": "string",
- "dollar_value": "string",
- "number": "string",
- "vendor_id": 0,
- "global_vendor_id": 0,
- "compliance_document_type_configuration_id": 0,
- "compliance_document_type_id": 0,
- "compliance_document_type_title": "string"
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
Retrieve a list of all the available tags. These can then be assigned or removed from vendors.
page | integer The page to be returned |
per_page | integer The number of results to show per page |
{- "data": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": 0,
- "created_at": "string"
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
List attached tags
vendorId required | integer Numeric ID of the vendor |
page | integer The page to be returned |
per_page | integer The number of results to show per page |
{- "data": [
- {
- "id": 0,
- "vendor_id": 0,
- "tag_id": 0,
- "tag_name": "string",
- "comment": "string",
- "created_at": "string",
- "updated_at": "string"
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
Attach a tag to a vendor
vendorId required | integer Numeric ID of the vendor |
tag_id | integer |
comment | string |
{- "tag_id": 0,
- "comment": "string"
}
{- "id": 0,
- "vendor_id": 0,
- "tag_id": 0,
- "tag_name": "string",
- "comment": "string",
- "created_at": "string",
- "updated_at": "string"
}
Update an attached tag
vendorId required | integer Numeric ID of the vendor |
attachedTagId required | integer Numeric ID of the attached tag |
comment | string |
{- "comment": "string"
}
{- "id": 0,
- "vendor_id": 0,
- "tag_id": 0,
- "tag_name": "string",
- "comment": "string",
- "created_at": "string",
- "updated_at": "string"
}
Detach a tag
vendorId required | integer Numeric ID of the vendor |
attachedTagId required | integer Numeric ID of the attached tag |
{- "error": {
- "code": 403,
- "message": "You do not have permission to detach this tag from this vendor."
}
}
List all external reference types
page | integer The page to be returned |
per_page | integer The number of results to show per page |
{- "data": [
- {
- "id": 0,
- "organisation_id": 0,
- "title": "string",
- "description": "string",
- "active": 0,
- "created_at": "string",
- "created_by": 0
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
List external references
vendorId required | integer Numeric ID of the vendor |
page | integer The page to be returned |
per_page | integer The number of results to show per page |
{- "data": [
- {
- "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"
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
Create an external reference
vendorId required | integer Numeric ID of the vendor |
external_reference_type_id | integer |
external_reference | string |
{- "external_reference_type_id": 0,
- "external_reference": "string"
}
{- "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 an external reference
vendorId required | integer Numeric ID of the vendor |
externalReferenceId required | integer Numeric ID of the external reference |
{- "error": {
- "code": 403,
- "message": "You do not have permission to remove this external reference from this vendor."
}
}
This method returns a list of all payment details for a chosen vendor
vendorId required | integer Numeric ID of the vendor |
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 = Declined |
{- "data": [
- {
- "id": 414,
- "preferred_payment_method": "eft",
- "bsb_number": "",
- "financial_institution": "Bank of India",
- "account_number": "string",
- "account_name": "string",
- "bpay_biller_code": "string",
- "bpay_crn": "string",
- "bank_address": "string",
- "swift_code": "BKIDINBBXXX",
- "iban_number": "string",
- "sort_code": "BKID0006581",
- "statement_by_supplier": 0,
- "account_contact_email": "string",
- "account_contact_phone": "string",
- "account_contact_first_name": "string",
- "account_contact_surname": "string",
- "supplier_comments": "string",
- "created_by_user_id": 0,
- "created_on": "string",
- "active": 0,
- "status": 1,
- "validated_by": null,
- "validated_on": "string",
- "declined_by": null,
- "declined_on": null,
- "reviewer_comments": "string",
- "payment_terms_id": 0,
- "ato_taxable_reporting": 0,
- "ato_taxable_reporting_updated_on": "string",
- "has_domestic_details": 1,
- "has_international_details": 1,
- "sort_code_label": "IFSC Code",
- "additional_routing_label": "MICR Code",
- "additional_routing_code": "148013052",
- "swift_optional_branch_code": null,
- "international_remittance_message": [
- {
- "msg_row_1": "Division 000",
- "msg_row_2": "Project ABC",
- "msg_row_3": "Attention-AR Team",
- "msg_row_4": ""
}
], - "account_currency": [
- {
- "currency_name": "US Dollar",
- "alpha_code": "USD",
- "numeric_code": "840"
}
], - "bank_country": [
- {
- "country_name": "India",
- "alpha_code": "IND"
}
]
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
This method returns a brief description of all projects in the current organisation. Limit up to 1000 per page.
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 |
{- "data": [
- {
- "id": 1234,
- "title": "Some Title",
- "status": {
- "id": "1",
- "title": "Draft"
}, - "fields": [
- {
- "id": 1,
- "title": "Field Title",
- "section": "Section Title",
- "value": "Some value"
}, - {
- "id": 2,
- "title": "Field Title 1",
- "section": "Section Title 2",
- "value": null
}
], - "created_at": "2020-02-10T22:08:19Z",
- "created_by": {
- "id": 1,
- "name": "John Doe"
}, - "updated_at": "2020-02-10T22:08:19Z",
- "updated_by": {
- "id": 2,
- "name": "Jane Doe"
}, - "access_type": "No Restriction"
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
This method returns details of an individual folder.
projectId required | integer Numeric ID of the project |
{- "id": 1234,
- "title": "Some Title",
- "status": {
- "id": "1",
- "title": "Draft"
}, - "fields": [
- {
- "id": 1,
- "title": "Field Title",
- "section": "Section Title",
- "value": "Some value"
}, - {
- "id": 2,
- "title": "Field Title 1",
- "section": "Section Title 2",
- "value": null
}
], - "created_at": "2020-02-10T22:08:19Z",
- "created_by": {
- "id": 1,
- "name": "John Doe"
}, - "updated_at": "2020-02-10T22:08:19Z",
- "updated_by": {
- "id": 2,
- "name": "Jane Doe"
}, - "access_type": "No Restriction"
}
This method returns project statuses for the current organisation.
page | integer The page to be returned |
per_page | integer The number of results to show per page |
{- "data": [
- {
- "id": 1234,
- "title": "Some Title",
- "sort_order": 1,
- "created_at": "2020-02-10T22:08:19Z"
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
This method returns a brief description of project folders in the current organisation. Limit up to 1000 per page.
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. |
{- "data": [
- {
- "id": 7846,
- "title": "Some Project Title",
- "project_id": 1243,
- "archived": true,
- "created_at": "2020-02-10T22:08:19Z",
- "created_by": {
- "id": 1,
- "name": "John Doe"
}, - "updated_at": "2020-02-10T22:08:19Z",
- "updated_by": {
- "id": 2,
- "name": "Jane Doe"
}
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
This method returns details of an individual folder.
folderId required | integer Numeric ID of the project folder |
{- "id": 7846,
- "title": "Some Project Title",
- "project_id": 1243,
- "archived": true,
- "created_at": "2020-02-10T22:08:19Z",
- "created_by": {
- "id": 1,
- "name": "John Doe"
}, - "updated_at": "2020-02-10T22:08:19Z",
- "updated_by": {
- "id": 2,
- "name": "Jane Doe"
}
}
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.
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. |
{- "data": [
- {
- "id": 1234,
- "title": "Some Title",
- "project": {
- "id": 1,
- "title": "example title"
}, - "project_folder": {
- "id": 1,
- "title": "example title"
}, - "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": {
- "id": 1,
- "name": "John Doe"
}, - "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": {
- "id": 1,
- "name": "John Doe"
}, - "is_sealed": false
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
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.
requestId required | integer Numeric ID of the sourcing request |
{- "id": 1234,
- "title": "Some Title",
- "project": {
- "id": 1,
- "title": "example title"
}, - "project_folder": {
- "id": 1,
- "title": "example title"
}, - "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": {
- "id": 1,
- "name": "John Doe"
}, - "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": {
- "id": 1,
- "name": "John Doe"
}, - "is_sealed": false
}
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.
projectId required | integer Numeric ID of a project |
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. |
{- "data": [
- {
- "id": 1234,
- "title": "Some Title",
- "project": {
- "id": 1,
- "title": "example title"
}, - "project_folder": {
- "id": 1,
- "title": "example title"
}, - "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": {
- "id": 1,
- "name": "John Doe"
}, - "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": {
- "id": 1,
- "name": "John Doe"
}, - "is_sealed": false
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
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.
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 |
{- "data": [
- {
- "id": 7846,
- "title": "1 x Tandem Tipper - Wet and dry quote",
- "request": {
- "id": 1283,
- "title": "request title"
}, - "category": {
- "id": 1287,
- "title": "category title"
}, - "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": [
- {
- "id": 46,
- "pricing_option_id": 343454,
- "title": "Dry Hourly"
}, - {
- "id": 35,
- "pricing_option_id": 343454,
- "title": "Wet Hourly"
}
], - "pricing_line_items": { },
- "is_sent": true,
- "responses": 10
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
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.
requestId | integer Example: 20384 sorcing request id |
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 |
{- "data": [
- {
- "id": 7846,
- "title": "1 x Tandem Tipper - Wet and dry quote",
- "request": {
- "id": 1283,
- "title": "request title"
}, - "category": {
- "id": 1287,
- "title": "category title"
}, - "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": [
- {
- "id": 46,
- "pricing_option_id": 343454,
- "title": "Dry Hourly"
}, - {
- "id": 35,
- "pricing_option_id": 343454,
- "title": "Wet Hourly"
}
], - "pricing_line_items": { },
- "is_sent": true,
- "responses": 10
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
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.
requestId | integer Example: 12345 Id of sorcing request |
itemId | integer Example: 12345 Id of sorcing request item |
{- "id": 7846,
- "title": "1 x Tandem Tipper - Wet and dry quote",
- "request": {
- "id": 1283,
- "title": "request title"
}, - "category": {
- "id": 1287,
- "title": "category title"
}, - "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": [
- {
- "id": 46,
- "pricing_option_id": 343454,
- "title": "Dry Hourly"
}, - {
- "id": 35,
- "pricing_option_id": 343454,
- "title": "Wet Hourly"
}
], - "pricing_line_items": { },
- "is_sent": true,
- "responses": 10
}
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.
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. |
{- "data": [
- {
- "id": 7846,
- "item": {
- "id": 1,
- "title": "Stage 2 - Earthworks",
- "is_sent": true
}, - "category": {
- "id": 345,
- "title": "11-15 Tonne Excavator"
}, - "title": "35T All Terrain",
- "description": "SIZE: 120L; 515mmW x 543mmD x 820mmH. Indicative M&M: Hisense 120L Bar Fridge - HR6BF121",
- "quantity": 5,
- "unit_of_measure": "Hrs",
- "custom_identifier": "20000.22000.22100",
- "budget": 34567,
- "budget_rate": 34567,
- "is_optional": false,
- "is_active": true,
- "created_at": "2020-02-10T22:08:19Z",
- "updated_at": "2020-02-10T22:08:19Z",
- "last_response_at": "2020-02-10T22:08:19Z",
- "responses": [
- {
- "id": 334345,
- "vendor_id": 343433,
- "global_vendor_id": 34345,
- "response_id": 45456,
- "value": 3454677,
- "quantity": 1,
- "exclusion": "At this stage none required",
- "inclusion": "Attachments- Auger/ Breaker/ Grab/Shaker Bucket/Tilt Hitch",
- "comment": "8hrs minimum",
- "created_at": "2020-02-10T22:08:19Z"
}, - {
- "id": 334334,
- "vendor_id": 3435,
- "global_vendor_id": 343345,
- "response_id": 454345,
- "value": 344596,
- "quantity": 1,
- "exclusion": "Nothing",
- "inclusion": "Something else here",
- "comment": "8hrs minimum",
- "created_at": "2020-02-10T22:08:19Z"
}
], - "schedule_version": 1
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
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.
requestId | integer Example: 20384 If of a request |
itemId | integer Example: 12345 Id of an item |
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. |
{- "data": [
- {
- "id": 7846,
- "item": {
- "id": 1,
- "title": "Stage 2 - Earthworks",
- "is_sent": true
}, - "category": {
- "id": 345,
- "title": "11-15 Tonne Excavator"
}, - "title": "35T All Terrain",
- "description": "SIZE: 120L; 515mmW x 543mmD x 820mmH. Indicative M&M: Hisense 120L Bar Fridge - HR6BF121",
- "quantity": 5,
- "unit_of_measure": "Hrs",
- "custom_identifier": "20000.22000.22100",
- "budget": 34567,
- "budget_rate": 34567,
- "is_optional": false,
- "is_active": true,
- "created_at": "2020-02-10T22:08:19Z",
- "updated_at": "2020-02-10T22:08:19Z",
- "last_response_at": "2020-02-10T22:08:19Z",
- "responses": [
- {
- "id": 334345,
- "vendor_id": 343433,
- "global_vendor_id": 34345,
- "response_id": 45456,
- "value": 3454677,
- "quantity": 1,
- "exclusion": "At this stage none required",
- "inclusion": "Attachments- Auger/ Breaker/ Grab/Shaker Bucket/Tilt Hitch",
- "comment": "8hrs minimum",
- "created_at": "2020-02-10T22:08:19Z"
}, - {
- "id": 334334,
- "vendor_id": 3435,
- "global_vendor_id": 343345,
- "response_id": 454345,
- "value": 344596,
- "quantity": 1,
- "exclusion": "Nothing",
- "inclusion": "Something else here",
- "comment": "8hrs minimum",
- "created_at": "2020-02-10T22:08:19Z"
}
], - "schedule_version": 1
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
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.
requestId | integer Example: 20384 Id of a request |
itemId | integer Example: 12345 Id of an item |
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. |
{- "data": [
- {
- "id": 334345,
- "vendor_id": 343433,
- "global_vendor_id": 34345,
- "vendor_registered_business_name": "Test",
- "request": {
- "id": 3454,
- "title": "Test 234"
}, - "status": "Quoted",
- "rejection_comment": "Too far away",
- "response": [
- {
- "id": 334345,
- "vendor_id": 343433,
- "global_vendor_id": 34345,
- "vendor_registered_business_name": "Test",
- "request": {
- "id": 3454,
- "title": "Test 234"
}, - "status": "Quoted",
- "rejection_comment": "Too far away",
- "response": [
- {
- "id": 334345,
- "item_id": 23233,
- "title": "Excavator 11t",
- "comments": "text string here",
- "quantity": 3,
- "pricing_option_responses": [
- {
- "id": 23343,
- "pricing_option_inst_id": 343443,
- "pricing_option_id": 23545,
- "pricing_option_title": "Wet Hourly",
- "value": 3434,
- "standby_value": 3434
}
], - "pricing_line_items": {
- "url": "https://"
}, - "submitted_at": "2020-02-10T22:08:19Z"
}
], - "is_manually_added": true,
- "created_at": "2020-02-10T22:08:19Z"
}
], - "is_manually_added": true,
- "created_at": "2020-02-10T22:08:19Z"
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
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.
recipientId | integer Example: 12345 Id of recipient |
{- "id": 334345,
- "vendor_id": 343433,
- "global_vendor_id": 34345,
- "vendor_registered_business_name": "Test",
- "request": {
- "id": 3454,
- "title": "Test 234"
}, - "status": "Quoted",
- "rejection_comment": "Too far away",
- "response": [
- {
- "id": 334345,
- "vendor_id": 343433,
- "global_vendor_id": 34345,
- "vendor_registered_business_name": "Test",
- "request": {
- "id": 3454,
- "title": "Test 234"
}, - "status": "Quoted",
- "rejection_comment": "Too far away",
- "response": [
- {
- "id": 334345,
- "item_id": 23233,
- "title": "Excavator 11t",
- "comments": "text string here",
- "quantity": 3,
- "pricing_option_responses": [
- {
- "id": 23343,
- "pricing_option_inst_id": 343443,
- "pricing_option_id": 23545,
- "pricing_option_title": "Wet Hourly",
- "value": 3434,
- "standby_value": 3434
}
], - "pricing_line_items": {
- "url": "https://"
}, - "submitted_at": "2020-02-10T22:08:19Z"
}
], - "is_manually_added": true,
- "created_at": "2020-02-10T22:08:19Z"
}
], - "is_manually_added": true,
- "created_at": "2020-02-10T22:08:19Z"
}
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.
requestId | integer Example: 20384 Id of a request |
itemId | integer Example: 12345 Id of an item |
page | integer The page to be returned |
per_page | integer The number of results to show per page |
{- "data": [
- {
- "id": 334345,
- "vendor_id": 343433,
- "global_vendor_id": 34345,
- "response_id": 45456,
- "rate": 3454677,
- "quantity_suggested": 1,
- "exclusion": "At this stage none required",
- "inclusion": "Attachments- Auger/ Breaker/ Grab/Shaker Bucket/Tilt Hitch",
- "comment": "8hrs minimum",
- "created_at": "2020-02-10T22:08:19Z"
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
This method returns a brief description of awards in the current organisation. Limit up to 1000 per page.
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:
|
{- "data": [
- {
- "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": {
- "id": "1",
- "title": "Excavator 10T"
}, - "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": {
- "id": "1",
- "title": "John Smith"
}
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
List all awards for a project
projectId required | integer Numeric ID of a project |
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:
|
{- "data": [
- {
- "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": {
- "id": "1",
- "title": "Excavator 10T"
}, - "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": {
- "id": "1",
- "title": "John Smith"
}
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
List all awards for a sourcing request item
itemId required | integer Numeric ID of a Sourcing Request Item |
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:
|
{- "data": [
- {
- "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": {
- "id": "1",
- "title": "Excavator 10T"
}, - "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": {
- "id": "1",
- "title": "John Smith"
}
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
Retrieve an award
awardId required | integer Numeric ID of the award |
{- "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": {
- "id": "1",
- "title": "Excavator 10T"
}, - "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": {
- "id": "1",
- "title": "John Smith"
}
}
This method returns all project packages.
projectId required | integer Numeric ID of the project |
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 |
{- "data": [
- {
- "id": 1,
- "project": {
- "id": "1",
- "title": "Project Title"
}, - "title": "Site Amenities",
- "description": "Description",
- "status": "Awarded",
- "package_group": {
- "id": "1",
- "title": "Preliminary Works"
}, - "owner": {
- "id": "1",
- "value": "John Doe"
}, - "category": {
- "id": "1",
- "value": "Site Amenities"
}, - "budget": 0,
- "target": 0,
- "forecast": 0,
- "fields": [
- {
- "id": 38,
- "uuid": "5b52ce9c-5735-4661-a15f-e03e79613831",
- "field_group": "",
- "title": "Title",
- "value": "Site Amenities"
}, - {
- "id": 39,
- "uuid": "9541655b-381e-4f2b-8793-cc2c1517062b",
- "field_group": "Details",
- "title": "Description",
- "value": "Description"
}, - {
- "id": 40,
- "uuid": "d56cdbbc-bcbd-4c57-b94d-87843a61c708",
- "field_group": "Details",
- "title": "Status",
- "value": "Awarded"
}, - {
- "id": 41,
- "uuid": "ca592b53-e7f4-465a-9b29-c29e9305dfc1",
- "field_group": "Details",
- "title": "Package Group",
- "value": "Preliminary Works"
}, - {
- "id": 42,
- "uuid": "b259100e-b05f-4151-ba45-03aa050c9303",
- "field_group": "Details",
- "title": "Category",
- "value": "Site Amenities"
}, - {
- "id": 43,
- "uuid": "855b2786-3de4-4873-a4fc-cedc59c7e31b",
- "field_group": "Details",
- "title": "Owner",
- "value": "John Doe"
}, - {
- "id": 45,
- "uuid": "2c10e939-f5e2-4398-baea-d502bdd05ea8",
- "field_group": "Budget",
- "title": "Budget",
- "value": 0
}, - {
- "id": 46,
- "uuid": "8b98993c-eb31-4c74-8460-a0049b004c81",
- "field_group": "Budget",
- "title": "Target",
- "value": 0
}, - {
- "id": 47,
- "uuid": "2d0dabd4-a88a-40ae-8a03-796b8a7262b7",
- "field_group": "Budget",
- "title": "Forecast",
- "value": 0
}
], - "created_at": "2021-09-23T11:00:00Z",
- "created_by": {
- "id": 1,
- "name": "John Doe"
}, - "updated_at": "2021-09-23T11:11:00Z",
- "updated_by": {
- "id": 2,
- "name": "Jane Doe"
}
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
Returns a list of all your users. Deleted users are not returned. Has a limit of 250 per page.
page | integer The page to be returned |
per_page | integer The number of results to show per page. Defaults to 25. Limited to 250. |
{- "data": [
- {
- "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"
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
This method returns details of an individual user.
userId required | integer The ID of the user |
{- "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"
}
Returns a list of all your security groups.
Deleted security groups are not returned. Has a limit of 250 per page.
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 |
{- "data": [
- {
- "id": 7846,
- "name": "Administrator",
- "group_type": "system",
- "created_at": "2024-01-09T04:47:29.000000Z",
- "created_by": 6,
- "updated_at": "2024-01-09T04:47:29.000000Z",
- "updated_by": 2
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
Returns a list of user memberships for security groups.
Deleted memberships are not returned. Has a limit of 250 per page.
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) |
{- "data": [
- {
- "id": 1,
- "user": 121,
- "security_group": 1,
- "created_at": "2024-01-09T04:47:29.000000Z"
}
], - "links": {
- "first": "string",
- "last": "string",
- "prev": "string",
- "next": "string"
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "path": "string",
- "per_page": 0,
- "to": 0,
- "total": 0
}
}