API explorerChangelog
API explorer
Changelog

Theme switcher

Introduction

Urable is an all-in-one business management application designed for service-based businesses. With a cloud-based infrastructure and dedicated mobile apps, it allows you to run your entire business from multiple devices in real-time.

Want to connect Urable to your favorite apps? Use out-of-box integrations or build your own using Urable's secure API. The API will open up endless customization opportunities and allow you to build your ideal ecosystem. Feel free to get in touch with us and we can help you get started.

Base URL

Production:

https://app.urable.com/api

Language Box

Customers

Customers are the individuals or businesses for whom your Jobs/Orders are created.

Items

An item is a customer possession on which a service is being performed. The terminology and fields of an item can change based on your selected industry. See below for industry and item terminology:

Industry

Item

Vehicle Care

Vehicle

Lawn Care

Property Section

Other

Item

Was this section helpful?

What made this section unhelpful for you?

Create an item

Creates a new item and attaches it to a customer in your account.

Header Parameters

Content-Typestring
Authorizationstring Required

Body Parameters

customerIdstring Required

The ID of the customer in Urable that owns this item.

typestring

This field is only utilized for vehicles. It is the type of vehicle.

Enum values:
automotivemarineaviationother
namestring Required

The name of the item.

photoURLstring

A URL pointing to a picture of the item.

vinsarray

This field is only utilized for vehicles. If only one VIN is listed then it will be considered a single vehicle. If more than one VIN is listed it will be considered a fleet of vehicles.

Show child attributes

licensePlatesarray

This field is only utilized for vehicles. If only one license plate is listed then it will be considered a single vehicle. If more than one license plate is listed it will be considered a fleet of vehicles.

Show child attributes

dimensionsobject

This field is only utilized for property sections and provides measurements for the property.

Show child attributes

locationobject

This field is only utilized for property sections since a property is tied to an address.

Show child attributes

customDataarray

An array of objects, each containing a custom key value pair.

notesstring

Any additional notes on the item.

Response

200
Object

Response Attributes

successboolean
dataobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/v1/items

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 curl --location 'https://app.urable.com/api/v1/items' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --data '{ "customerId": "CAxSoHm7IQo6z9WDMdUo", "type": "automotive", "name": "2014 McLaren P1", "photoURL": null, "vins": [ "ABCDEFGHIJKLMNOPQ" ], "licensePlates": [ "ABC123" ], "dimensions": { "area": null, "length": null, "volume": null }, "location": { "label": "Home", "value": { "address": { "line1": "123 Any Street", "line2": "", "city": "Anytown", "state": "PA", "country": "US" } } }, "customData": [], "notes": "This car is very important to the customer so be extra careful." }'

Response

{
  "success": true,
  "data": {
    "id": "giChXvD1rENCq7SuX7dA"
  }
}
Was this section helpful?

What made this section unhelpful for you?

Update an item

Updates an existing item in your account.

Note: You can remove any property you don't want update in the request.

Header Parameters

Content-Typestring
Authorizationstring Required

Path Parameters

idstring Required

The ID of the item in Urable.

Body Parameters

customerIdstring

The ID of the customer in Urable that owns this item.

typestring

This field is only utilized for vehicles. It is the type of vehicle.

Enum values:
automotivemarineaviationother
namestring

The name of the item

photoURLstring

A URL pointing to a picture of the item

vinsarray

This field is only utilized for vehicles. If only one VIN is listed then it will be considered a single vehicle. If more than one VIN is listed it will be considered a fleet of vehicles.

Show child attributes

licensePlatesarray

This field is only utilized for vehicles. If only one license plate is listed then it will be considered a single vehicle. If more than one license plate is listed it will be considered a fleet of vehicles.

Show child attributes

dimensionsobject

This field is only utilized for property sections and provides measurements for the property.

Show child attributes

locationobject

This field is only utilized for property sections since a property is tied to an address.

Show child attributes

customDataarray

An array of objects, each containing a custom key value pair.

notesstring

Any additional notes on the item

Response

200
Object

Response Attributes

successboolean
dataobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

PATCH

/v1/items/{id}

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 curl --location --request PATCH 'https://app.urable.com/api/v1/items/giChXvD1rENCq7SuX7dA' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --data '{ "customerId": "CAxSoHm7IQo6z9WDMdUo", "type": "automotive", "name": "2014 McLaren P1", "photoURL": null, "vins": [ "ABCDEFGHIJKLMNOPQ" ], "licensePlates": [ "ABC123" ], "dimensions": { "area": null, "length": null, "volume": null }, "location": { "label": "Home", "value": { "address": { "line1": "123 Any Street", "line2": "", "city": "Anytown", "state": "PA", "country": "US" } } }, "customData": [], "notes": "This car is very important to the customer so be extra careful" }'

Response

{
  "success": true,
  "data": {
    "id": "giChXvD1rENCq7SuX7dA"
  }
}
Was this section helpful?

What made this section unhelpful for you?

Retrieve an item

Retrieves an existing item from your account.

Header Parameters

Content-Typestring
Authorizationstring Required

Path Parameters

idstring Required

The ID of the item in Urable.

Response

200
Object

Response Attributes

successboolean
dataobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/v1/items/{id}

Select
1 2 3 curl --location 'https://app.urable.com/api/v1/items/giChXvD1rENCq7SuX7dA' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ACCESS_TOKEN'

Response

{
  "success": true,
  "data": {
    "id": "giChXvD1rENCq7SuX7dA",
    "type": "automotive",
    "name": "2014 McLaren P1",
    "customerName": "John Smith",
    "customerRef": "accounts/3xWVrkuKYrzlwZ72Vn4F/customers/CAxSoHm7IQo6z9WDMdUo",
    "photoURL": "https://firebasestorage.googleapis.com/v0/b/urabledev.appspot.com/o/accounts%2F3xWVrkuKYrzlwZ72Vn4F%2Fitems%2FgiChXvD1rENCq7SuX7dA?alt=media&token=52923ada-c4fb-4743-bebf-e1c512f955a5",
    "metadata": {
      "vins": [
        "ABCDEFGHIJKLMNOPQ"
      ],
      "licensePlates": [
        "ABC123"
      ]
    },
    "notes": "This car is very important to the customer so be extra careful.",
    "created": {
      "uid": "Oh4tLpllmFWt2Ek5aJQaV7fDbj23",
      "timestamp": 1657230265020
    },
    "modified": {
      "uid": "Oh4tLpllmFWt2Ek5aJQaV7fDbj23",
      "timestamp": 1703278114700
    }
  }
}
Was this section helpful?

What made this section unhelpful for you?

List items

Returns a list of your customers items. The items are returned sorted by creation date, with the most recent items appearing first.

Header Parameters

Content-Typestring
Authorizationstring Required

Query Parameters

vinstring

A filter on the list based on the vehicles VIN.

startAfterstring

A cursor for use in pagination. startAfter is an item ID that defines your place in the list. For instance, if you make a list request and receive 100 items, ending with giChXvD1rENCq7SuX7dA, your subsequent call can include startAfter= giChXvD1rENCq7SuX7dA in order to fetch the next page of the list.

endBeforestring

A cursor for use in pagination. endBefore is an item ID that defines your place in the list. For instance, if you make a list request and receive 100 items, starting with giChXvD1rENCq7SuX7dA, your subsequent call can include endBefore=giChXvD1rENCq7SuX7dA in order to fetch the next page of the list.

limitstring

A limit on the number of items to be returned. Limit can range between 1 and 100.

Response

200
Object

Response Attributes

successboolean
dataarray

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/v1/items?vin=ABCDEFGHIJKLMNOPQ&startAfter=&endBefore=&limit=10

Select
1 2 3 curl --location 'https://app.urable.com/api/v1/items?vin=ABCDEFGHIJKLMNOPQ&limit=10' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ACCESS_TOKEN'

Response

{
  "success": true,
  "data": [
    {
      "id": "giChXvD1rENCq7SuX7dA",
      "type": "automotive",
      "name": "2014 McLaren P1",
      "customerName": "John Smith",
      "customerRef": "accounts/3xWVrkuKYrzlwZ72Vn4F/customers/CAxSoHm7IQo6z9WDMdUo",
      "photoURL": "https://firebasestorage.googleapis.com/v0/b/urabledev.appspot.com/o/accounts%2F3xWVrkuKYrzlwZ72Vn4F%2Fitems%2FgiChXvD1rENCq7SuX7dA?alt=media&token=52923ada-c4fb-4743-bebf-e1c512f955a5",
      "metadata": {
        "vins": [
          "ABCDEFGHIJKLMNOPQ"
        ],
        "licensePlates": [
          "ABC123"
        ]
      },
      "notes": "This car is very important to the customer so be extra careful.",
      "created": {
        "uid": "Oh4tLpllmFWt2Ek5aJQaV7fDbj23",
        "timestamp": 1657230265020
      },
      "modified": {
        "uid": "Oh4tLpllmFWt2Ek5aJQaV7fDbj23",
        "timestamp": 1703278114700
      }
    }
  ]
}
Was this section helpful?

What made this section unhelpful for you?

Delete an item

Deletes an existing item from your account.

Header Parameters

Content-Typestring
Authorizationstring Required

Path Parameters

idstring Required

The ID of the item in Urable.

Response

200
Object

Response Attributes

successboolean
dataobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

DELETE

/v1/items/{id}

Select
1 2 3 curl --location --request DELETE 'https://app.urable.com/api/v1/items/giChXvD1rENCq7SuX7dA' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ACCESS_TOKEN'

Response

{
  "success": true,
  "data": {
    "id": "giChXvD1rENCq7SuX7dA"
  }
}
Was this section helpful?

What made this section unhelpful for you?