Retrieve Company

Retrieves a single active and non-deleted company record by its document_id. Supports field selection and relation population via query parameters.

Endpoint

GET /api/v3/product/company/{documentId}

Authentication

This endpoint requires authentication. Include a valid bearer token in the Authorization header. Permission Required: company:find-one

Path Parameters

Query Parameters

Response

Success Response (200 OK)

Returns the requested company record.

{
  "message": "Company record retrieved successfully",
  "data": {
    "document_id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Acme Corporation",
    "internal": "ACME",
    "description": "A leading technology company",
    "image": "https://example.com/logo.png",
    "is_actived": true,
    "is_deleted": false,
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z",
    "deleted_at": null
  },
  "meta": {
    "correlation": "29146752-ef3a-4569-b397-ff2144412c4a",
    "status": 200,
    "timestamp": "2024-01-01T00:00:00.000Z"
  }
}

Error Responses

400 Bad Request - Invalid field provided or invalid UUID format

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid field: 'invalid_field'. The specified field does not exist in the table."
  },
  "meta": {
    "correlation": "...",
    "status": 400,
    "timestamp": "..."
  }
}

401 Unauthorized - Missing or invalid authentication token 403 Forbidden - Insufficient permissions 404 Not Found - Record not found, inactive, or deleted

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Record with document_id '550e8400-e29b-41d4-a716-446655440000' not found"
  },
  "meta": {
    "correlation": "...",
    "status": 404,
    "timestamp": "..."
  }
}

Examples

Basic Request

curl -X GET 'https://api.bbrands.io/api/v3/product/company/550e8400-e29b-41d4-a716-446655440000' \
  -H 'Authorization: Bearer YOUR_TOKEN'

With Field Selection

curl -X GET 'https://api.bbrands.io/api/v3/product/company/550e8400-e29b-41d4-a716-446655440000?fields=name,internal,description' \
  -H 'Authorization: Bearer YOUR_TOKEN'

With Relations

curl -X GET 'https://api.bbrands.io/api/v3/product/company/550e8400-e29b-41d4-a716-446655440000?populate=relation1,relation2' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Account

Authentication

General

Geolocation

Maihue

Product

Endpoint

Authentication

Path Parameters

Query Parameters

Response

Success Response (200 OK)

Error Responses

Examples

Basic Request

With Field Selection

With Relations

​Endpoint

​Authentication

​Path Parameters

​Query Parameters

​Response

​Success Response (200 OK)

​Error Responses

​Examples

​Basic Request

​With Field Selection

​With Relations

Endpoint

Authentication

Path Parameters

Query Parameters

Response

Success Response (200 OK)

Error Responses

Examples

Basic Request

With Field Selection

With Relations