Skip to content
  •  
  •  
  •  
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
$kind: collection
description: |-
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.
order: 4000
71 changes: 53 additions & 18 deletions postman/collections/Fleetbase API/Contacts/.resources/object.yaml
Original file line number Diff line number Diff line change
@@ -1,37 +1,72 @@
$kind: object
name: Contact
description: |-
A contact represents a contact record managed through the Fleetbase API. It includes a stable identifier, lifecycle state, timestamps, and the resource-specific attributes returned by the API.
example: |-
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.
example: |
{
"id": "contact_abc123",
"object": "contact",
"id": "contact_6zV1KqN9pR",
"customer_id": "customer_6zV1KqN9pR",
"internal_id": "CUST-1001",
"name": "John Doe",
"type": "customer",
"title": "Mr",
"email": "john@example.com",
"phone": "+15555550100",
"created_at": "2026-05-07T12:00:00Z"
"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"
}
fields:
- name: id
type: string
description: "Unique identifier for the resource."
- name: object
description: Public contact identifier.
- name: customer_id
type: string
description: Customer-form identifier returned for public customer contacts.
- name: internal_id
type: string
description: "Object type returned by the API."
description: Optional internal identifier.
- name: name
type: string
description: "Display name for the resource."
- name: type
type: enum
values: ["customer", "vendor", "driver"]
description: "Classification used to group or process the resource."
description: Contact display name.
- name: title
type: string
description: Contact title.
- name: email
type: string
description: "Email address for the person or customer."
description: Contact email address.
- name: phone
type: string
description: "Phone number for the person or customer."
description: Contact phone number.
- name: photo_url
type: string
description: Contact photo URL.
- name: place
type: object
description: Primary place for the contact, when loaded.
- name: places
type: array of objects
description: Places associated with the contact, when loaded.
- name: user
type: string
description: Public user ID linked to the contact, when present.
- name: type
type: string
description: Contact type.
- name: meta
type: object
description: Additional contact metadata.
- name: slug
type: string
description: URL-friendly contact slug.
- name: updated_at
type: timestamp
description: Timestamp when the contact was last updated.
- name: created_at
type: timestamp
description: "Time when the resource was created."
description: Timestamp when the contact was created.
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,26 @@ fields:
- name: name
type: string
required: true
description: "Display name for the resource."
description: Contact display name.
- name: type
type: enum
values: ["customer", "vendor", "driver"]
description: "Classification used to group or process the resource."
type: string
required: true
description: Contact type, such as `customer`, `technician`, or another application-defined type.
- name: title
type: string
description: "Optional title associated with the contact or person."
description: Optional contact title.
- name: email
type: string
description: "Email address for the person or customer."
description: Contact email address.
- name: phone
type: string
description: "Phone number for the person or customer."
description: Contact phone number.
- name: photo
type: string
description: File ID, upload reference, or resolvable file input for the contact photo.
- name: place
type: string
description: Place ID to use as the contact's primary place.
- name: meta
type: object
description: Additional contact metadata.
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
$kind: http-request
description: Create a new Contact.
description: |-
Creates a contact for the current company. Contacts are used as customers, facilitators, personnel, or other addressable people in FleetOps workflows.
url: "{{base_url}}/{{namespace}}/contacts"
method: POST
headers:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
$kind: http-request
description: |-
Deletes a contacts resource. The response confirms the resource that was removed.
description: Delete a Contact.
url: "{{base_url}}/{{namespace}}/contacts/:id"
method: DELETE
headers:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@ $kind: params
fields:
- name: query
type: string
description: "Query value for this contacts request."
description: Search term matched against contact fields.
- name: limit
type: string
description: "Limit value for this contacts request."
type: integer
description: Maximum number of contacts to return.
- name: offset
type: string
description: "Offset value for this contacts request."
type: integer
description: Number of contacts to skip before returning results.
- name: sort
type: string
description: "Sort value for this contacts request."
description: Sort expression for the contact query.
- name: type
type: string
description: Filters contacts by contact type.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
$kind: http-request
description: |-
Returns contacts matching the supplied filters. Use pagination and query parameters to control the result set.
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.
url: "{{base_url}}/{{namespace}}/contacts"
method: GET
headers:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,25 @@ $kind: params
fields:
- name: name
type: string
description: "Display name for the resource."
description: Contact display name.
- name: type
type: string
description: Contact type.
- name: title
type: string
description: "Optional title associated with the contact or person."
description: Optional contact title.
- name: email
type: string
description: "Email address for the person or customer."
description: Contact email address.
- name: phone
type: string
description: "Phone number for the person or customer."
- name: type
type: enum
values: ["customer", "vendor", "driver"]
description: "Classification used to group or process the resource."
- name: slug
description: Contact phone number.
- name: photo
type: string
description: File ID, upload reference, or resolvable file input for the contact photo.
- name: place
type: string
description: "URL-friendly identifier for the resource."
description: Place ID to use as the contact's primary place.
- name: meta
type: object
description: Additional contact metadata.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
$kind: http-request
description: |-
Updates a contact. Parameters not supplied remain unchanged.
Updates a contact's profile, type, primary place, photo, or metadata.
url: "{{base_url}}/{{namespace}}/contacts/:id"
method: PUT
headers:
Expand All @@ -18,7 +18,9 @@ body:
"email": "john@exampleco.com",
"phone": "563-920-4264",
"type": "technician",
"slug": "john-doe"
"meta": {
"external_ref": "john-doe"
}
}
examples: ./.resources/Update a Contact.resources/examples
order: 4000

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading
Loading