Suppliers API
Access and create your suppliers.
Read scope: suppliers:read
Write scope: suppliers:write
List Suppliers
GET /suppliersReturns all suppliers for your business.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
page_size | integer | Items per page (default: 50, max: 100) |
Example Request
curl -H "Authorization: Bearer rb_live_YOUR_API_KEY" \
"https://api.rebased.app/api/v1/external/suppliers?page=1"Example Response
{
"suppliers": [
{
"id": "660e8400-e29b-41d4-a716-446655440000",
"name": "Office Supplies Co",
"tax_number": "98765432100",
"address_line_1": "456 Supplier Road",
"address_line_2": null,
"city": "Melbourne",
"state": "VIC",
"postcode": "3000",
"country": "Australia",
"created_at": "2026-01-10T08:00:00Z",
"updated_at": "2026-02-15T11:30:00Z"
}
],
"total": 1,
"page": 1,
"page_size": 50,
"has_more": false
}Get Supplier
GET /suppliers/{id}Returns a single supplier by ID.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string (UUID) | The supplier ID |
Example Request
curl -H "Authorization: Bearer rb_live_YOUR_API_KEY" \
"https://api.rebased.app/api/v1/external/suppliers/660e8400-e29b-41d4-a716-446655440000"Create Supplier
POST /suppliersCreates a new supplier.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Supplier name |
tax_number | string | No | Tax identification number (ABN/ACN for AU) |
address_line_1 | string | No | Street address line 1 |
address_line_2 | string | No | Street address line 2 |
city | string | No | City |
state | string | No | State/province |
postcode | string | No | Postal code |
country | string | No | Country (default: Australia) |
email | string | No | Supplier email (displayed on supplier detail) |
phone | string | No | Supplier phone (displayed on supplier detail) |
contacts | array | No | Array of contact objects to create (see below) |
Contact Object (in contacts array)
| Field | Type | Required | Description |
|---|---|---|---|
first_name | string | Yes | Contact first name |
last_name | string | No | Contact last name |
email | string | No | Contact email |
phone | string | No | Contact phone |
mobile | string | No | Contact mobile |
position | string | No | Job title / position |
is_purchasing_contact | boolean | No | Purchasing contact flag (default: false) |
is_accounts_contact | boolean | No | Accounts contact flag (default: false) |
Note: If
contactsis not provided butphoneis, a contact will be automatically created using the supplier name.
Example Request
curl -X POST \
-H "Authorization: Bearer rb_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Office Supplies Co",
"tax_number": "98765432100",
"email": "orders@officesupplies.com",
"phone": "+61 3 9876 5432",
"address_line_1": "456 Supplier Road",
"city": "Melbourne",
"state": "VIC",
"postcode": "3000",
"contacts": [
{
"first_name": "Bob",
"last_name": "Jones",
"email": "bob@officesupplies.com",
"position": "Account Manager",
"is_accounts_contact": true
}
]
}' \
"https://api.rebased.app/api/v1/external/suppliers"Example Response (201 Created)
{
"id": "660e8400-e29b-41d4-a716-446655440000",
"name": "Office Supplies Co",
"tax_number": "98765432100",
"address_line_1": "456 Supplier Road",
"address_line_2": null,
"city": "Melbourne",
"state": "VIC",
"postcode": "3000",
"country": "Australia",
"created_at": "2026-04-04T08:00:00Z",
"updated_at": null
}Supplier Object
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier (UUID) |
name | string | Supplier name |
tax_number | string | Tax identification number (ABN/ACN for AU) |
address_line_1 | string | Street address line 1 |
address_line_2 | string | Street address line 2 |
city | string | City |
state | string | State/province |
postcode | string | Postal code |
country | string | Country |
created_at | datetime | When the supplier was created |
updated_at | datetime | When the supplier was last updated |
Last updated on