POST

DocumentStatuses.Get

Return one document_status row. Same as dashboard setting2/edit_document_status (loads name_en, name_he, color into the form).

Permissions

  • User must be logged in with a valid bearer token.
  • Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

  • Returns DocumentStatuses information as JSON for the UI.

Push Service

No push is sent because this function only reads data or returns helper information.

Automation

No automation is run for this function.

Special Instructions

  • Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
  • Send parameters as POST body fields exactly as documented.

Required Parameters

NameTypeSampleExplanation
document_status_id
post
int3453Row id. Aliases: status_id, id, data_id.

Optional Parameters

No optional body parameters are defined for this function.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/DocumentStatuses.Get",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "document_status_id": "3453"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/DocumentStatuses.Get",
    "url_domain": "https:\/\/{domain}\/app\/DocumentStatuses.Get"
}

Endpoint

POST /app/DocumentStatuses.Get
POST https://{user}.bull36.com/app/DocumentStatuses.Get
POST https://{domain}/app/DocumentStatuses.Get

Sample Output

{
    "success": 1,
    "data": {
        "id": 3453,
        "name_en": "In Production",
        "name_he": "In Production",
        "color": "#c48bb8",
        "type_for": "purchase_orders"
    }
}

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams({ document_status_id: '3453' });
const res = await fetch('/app/DocumentStatuses.Get', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
console.log(await res.json());

Error Example

{
    "success": 0,
    "message": "Document status not found"
}