> ## Documentation Index
> Fetch the complete documentation index at: https://docs.api.onechain-tms.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Fetch all users
> Fetch all users of the company
## OpenAPI
````yaml openapi.json get /v1/users
openapi: 3.1.0
info:
title: OneChain API
version: 1.3.2
x-logo:
href: https://www.onechain-tms.com
url: static/logo.png
servers:
- url: localhost:8080
security: []
tags:
- description: |-
This API lets you fetch your data from ONECHAIN's servers.
URL: https://api.onechain-tms.com
name: Introduction
x-displayName: Introduction
- description: >-
To safely access the resources exposed by our API, you will need to
provide an authenticated token in your requests headers. Please reach out
to your ONECHAIN’s Account Manager to get your token.
| Name of the header | Type of authentication |
|--------------------|------------------------|
| Authorization | API AUTHORIZATION KEY |
Please note that the API authorization key must be prefixed with "Bearer "
For example:
`Authorization: Bearer 1234567890`
name: Authentication
x-displayName: Authentication
- description: |-
All endpoints fetching multiple items are paginated.
Use `skip` to skip to the items you want to retrieve.
Use `take` to define how many items you want to retrieve.
`skip` and `take` are optional parameters.
If you do not input them, `skip` equals to 0 and `take` equals to 10.
Example:
`/v1/shipments?skip=20&take=10`
name: Pagination
x-displayName: Pagination
- name: Shipments
- name: Purchase Orders
- name: Documents
- name: Locations
- name: Invoices
- name: Users
- name: Reporting
- description:
name: ShipmentObject
x-displayName: ShipmentObject
- description:
name: TrackingObject
x-displayName: TrackingObject
- description:
name: OrderPreparationObject
x-displayName: OrderPreparationObject
- description:
name: PurchaseOrderObject
x-displayName: PurchaseOrderObject
- description:
name: TrackingEventObject
x-displayName: TrackingEventObject
- description:
name: TrackingDateObject
x-displayName: TrackingDateObject
- description:
name: TrackingStepObject
x-displayName: TrackingStepObject
- description:
name: ProductObject
x-displayName: ProductObject
- description:
name: PortObject
x-displayName: PortObject
- description:
name: CoordinatesObject
x-displayName: CoordinatesObject
- description:
name: ContainerObject
x-displayName: ContainerObject
- description:
name: UserObject
x-displayName: UserObject
- description:
name: LoadObject
x-displayName: LoadObject
- description:
name: DocumentObject
x-displayName: DocumentObject
- description:
name: InvoiceObject
x-displayName: InvoiceObject
- description:
name: LocationObject
x-displayName: LocationObject
- description:
name: PriceObject
x-displayName: PriceObject
- description:
name: QuantityObject
x-displayName: QuantityObject
- description:
name: SizeObject
x-displayName: SizeObject
- description:
name: VolumeObject
x-displayName: VolumeObject
- description:
name: WeightObject
x-displayName: WeightObject
- description:
name: SimpleDateObject
x-displayName: SimpleDateObject
- description:
name: DateWithTimeObject
x-displayName: DateWithTimeObject
paths:
/v1/users:
get:
tags:
- Users
summary: Fetch all users
description: Fetch all users of the company
responses:
'200':
description: Returns all users.
content:
application/json:
schema:
description: Returns all users.
items:
$ref: '#/components/schemas/User'
type: array
'404':
description: No user found
content:
application/json:
schema:
description: No user found
type: object
components:
schemas:
User:
modelName: User
type: object
description: User object
properties:
id:
type: string
example: '12345'
email:
type: string
example: user@email.com
first_name:
type: string
example: John
last_name:
type: string
example: Doe
phone:
type: string
example: '0776655443'
role:
type: string
example: manager
````