Skip to Content

Clients API

Access and create your clients.

Read scope: clients:read Write scope: clients:write

List Clients

GET /clients

Returns all clients for your business.

Query Parameters

ParameterTypeDescription
pageintegerPage number (default: 1)
page_sizeintegerItems per page (default: 50, max: 100)

Example Request

curl -H "Authorization: Bearer rb_live_YOUR_API_KEY" \
  "https://api.rebased.app/api/v1/external/clients?page=1"

Example Response

{
  "clients": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Acme Corporation",
      "email": "accounts@acme.com",
      "phone": "+61 2 9876 5432",
      "address_line_1": "123 Business Street",
      "address_line_2": "Suite 100",
      "city": "Sydney",
      "state": "NSW",
      "postcode": "2000",
      "country": "Australia",
      "tax_number": "12345678901",
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-02-20T14:45:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 50,
  "has_more": false
}

Get Client

GET /clients/{id}

Returns a single client by ID.

Path Parameters

ParameterTypeDescription
idstring (UUID)The client ID

Example Request

curl -H "Authorization: Bearer rb_live_YOUR_API_KEY" \
  "https://api.rebased.app/api/v1/external/clients/550e8400-e29b-41d4-a716-446655440000"

Create Client

POST /clients

Creates a new client.

Request Body

FieldTypeRequiredDescription
namestringYesClient name
emailstringNoEmail address
phonestringNoPhone number
address_line_1stringNoStreet address line 1
address_line_2stringNoStreet address line 2
citystringNoCity
statestringNoState/province
postcodestringNoPostal code
countrystringNoCountry (default: Australia)
tax_numberstringNoTax identification number (ABN for AU)
contactsarrayNoArray of contact objects to create (see below)

Contact Object (in contacts array)

FieldTypeRequiredDescription
first_namestringYesContact first name
last_namestringNoContact last name
emailstringNoContact email
phonestringNoContact phone
is_primarybooleanNoWhether this is the primary contact (default: true)

Note: If contacts is not provided but email or phone is, a primary contact will be automatically created using the client name.

Example Request

curl -X POST \
  -H "Authorization: Bearer rb_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corporation",
    "email": "accounts@acme.com",
    "phone": "+61 2 9876 5432",
    "address_line_1": "123 Business Street",
    "city": "Sydney",
    "state": "NSW",
    "postcode": "2000",
    "tax_number": "12345678901",
    "contacts": [
      {
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "jane@acme.com",
        "phone": "+61 400 123 456",
        "is_primary": true
      }
    ]
  }' \
  "https://api.rebased.app/api/v1/external/clients"

Example Response (201 Created)

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Acme Corporation",
  "email": "accounts@acme.com",
  "phone": "+61 2 9876 5432",
  "address_line_1": "123 Business Street",
  "address_line_2": null,
  "city": "Sydney",
  "state": "NSW",
  "postcode": "2000",
  "country": "Australia",
  "tax_number": "12345678901",
  "created_at": "2026-04-04T10:30:00Z",
  "updated_at": null
}

Client Object

FieldTypeDescription
idstringUnique identifier (UUID)
namestringClient name
emailstringEmail address
phonestringPhone number
address_line_1stringStreet address line 1
address_line_2stringStreet address line 2
citystringCity
statestringState/province
postcodestringPostal code
countrystringCountry
tax_numberstringTax identification number (ABN for AU)
created_atdatetimeWhen the client was created
updated_atdatetimeWhen the client was last updated
Last updated on
AU Overview