Get all corporates

GET 
/v1/corporates

Retrieves a paginated list of corporate accounts. Supports filtering by company name.

Request

Query Parameters

page number

Possible values: >= 1

Default value: 1

Page number (default: 1)

limit number

Possible values: >= 1

Default value: 10

Items per page (default: 10)

name string

Filter by company name (case-insensitive)

Responses

200

List of corporates retrieved successfully

application/json

Schema

Schema

data object[]required
The data of the paginated response
Array [
_id stringrequired
The ID of the corporate
companyInfo objectrequired
The company info of the corporate
name string
address string
invoiceEmail string
companyId string
confirmEmail string
vATNumber string
colorCodeBooking string
adminAccount objectrequired
The admin account of the corporate
firstName stringrequired
First name
lastName string
Last name
email stringrequired
Email
phone string
Phone
username stringrequired
User name
]
total numberrequired

The total number of items

page numberrequired

The current page

limit numberrequired

The number of items per page

totalPages numberrequired

The total number of pages

Example (from schema)

{
  "data": [
    {
      "_id": "672d07188234567890123456",
      "companyInfo": {
        "name": "ABC Corporation",
        "address": "123 Main St",
        "invoiceEmail": "invoice@goodjourney.io",
        "companyId": "1234567890",
        "confirmEmail": "john.doe@goodjourney.io",
        "vATNumber": "1234567890",
        "colorCodeBooking": "#000000"
      },
      "adminAccount": {
        "firstName": "James",
        "lastName": "Bond",
        "email": "jamesbond@goodjourney.io",
        "phone": "+1234567890",
        "username": "jamesbond"
      }
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}

Loading...