FleetbaseFleetbase
Start Free Trial

Contacts

Contacts represent customers, recipients, senders, and other people or organizations connected to logistics activity. Use contacts to attach identity, communication details, and default places to orders and payloads.

The Contact object

A contact represents a person or customer profile used by FleetOps resources. Contacts can own places, appear as customers, and carry contact details, photos, type, slug, and metadata.
Attributes
idstringoptional

Public contact identifier.

customer_idstringoptional

Customer-form identifier returned for public customer contacts.

internal_idstringoptional

Optional internal identifier.

namestringoptional

Contact display name.

titlestringoptional

Contact title.

emailstringoptional

Contact email address.

phonestringoptional

Contact phone number.

photo_urlstringoptional

Contact photo URL.

placeobjectoptional

Primary place for the contact, when loaded.

placesarray of objectsoptional

Places associated with the contact, when loaded.

userstringoptional

Public user ID linked to the contact, when present.

typestringoptional

Contact type.

metaobjectoptional

Additional contact metadata.

slugstringoptional

URL-friendly contact slug.

updated_attimestampoptional

Timestamp when the contact was last updated.

created_attimestampoptional

Timestamp when the contact was created.

The Contact object
{
  "id": "contact_6zV1KqN9pR",
  "customer_id": "customer_6zV1KqN9pR",
  "internal_id": "CUST-1001",
  "name": "John Doe",
  "title": "Mr",
  "email": "john@example.com",
  "phone": "+15639204264",
  "photo_url": null,
  "place": null,
  "places": [],
  "user": null,
  "type": "customer",
  "meta": {},
  "slug": "john-doe",
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}
POST/v1/contacts

Create a Contact

Creates a contact for the current company. Contacts are used as customers, facilitators, personnel, or other addressable people in FleetOps workflows.

Body parameters
namestringrequired

Contact display name.

typestringrequired

Contact type, such as customer, technician, or another application-defined type.

titlestringoptional

Optional contact title.

emailstringoptional

Contact email address.

phonestringoptional

Contact phone number.

photostringoptional

File ID, upload reference, or resolvable file input for the contact photo.

placestringoptional

Place ID to use as the contact's primary place.

metaobjectoptional

Additional contact metadata.

POST/v1/contacts
curl -X POST https://api.fleetbase.io/v1/contacts \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "name": "John Doe",
  "type": "customer",
  "title": "Mr",
  "email": "john@exampleco.com",
  "phone": "+1 563-920-4264"
}'
200 OK
{
  "id": "<string>",
  "name": "<string>",
  "title": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "phone_country_code": "<string>",
  "type": "<string>",
  "slug": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}
GET/v1/contacts

Query Contacts

Returns a paginated list of contacts for the current organization. Use filters such as query, limit, offset, and sort to narrow and order the results.

Query parameters
querystringoptional

Search term matched against contact fields.

limitintegeroptional

Maximum number of contacts to return.

offsetintegeroptional

Number of contacts to skip before returning results.

sortstringoptional

Sort expression for the contact query.

typestringoptional

Filters contacts by contact type.

GET/v1/contacts
curl https://api.fleetbase.io/v1/contacts?query={{contact_name}}&limit=25&offset=0&sort=created_at \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"
200 OK
{
  "id": "<string>",
  "name": "<string>",
  "title": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "phone_country_code": "<string>",
  "type": "<string>",
  "slug": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}
GET/v1/contacts/:id

Retrieve a Contact

Retrieve a Contact.

GET/v1/contacts/:id
curl https://api.fleetbase.io/v1/contacts/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"
200 OK
{
  "id": "<string>",
  "name": "<string>",
  "title": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "phone_country_code": "<string>",
  "type": "<string>",
  "slug": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}
PUT/v1/contacts/:id

Update a Contact

Updates a contact's profile, type, primary place, photo, or metadata.

Body parameters
namestringoptional

Contact display name.

typestringoptional

Contact type.

titlestringoptional

Optional contact title.

emailstringoptional

Contact email address.

phonestringoptional

Contact phone number.

photostringoptional

File ID, upload reference, or resolvable file input for the contact photo.

placestringoptional

Place ID to use as the contact's primary place.

metaobjectoptional

Additional contact metadata.

PUT/v1/contacts/:id
curl -X PUT https://api.fleetbase.io/v1/contacts/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "John Doe",
    "title": "Mr",
    "email": "john@exampleco.com",
    "phone": "563-920-4264",
    "type": "technician",
    "meta": {
        "external_ref": "john-doe"
    }
}'
200 OK
{
  "id": "<string>",
  "name": "<string>",
  "title": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "phone_country_code": "<string>",
  "type": "<string>",
  "slug": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}
DELETE/v1/contacts/:id

Delete a Contact

Delete a Contact.

DELETE/v1/contacts/:id
curl -X DELETE https://api.fleetbase.io/v1/contacts/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"
200 OK
{
  "deleted": "<boolean>",
  "id": "<string>"
}
Contacts | Fleetbase