MENU navbar-image

Introduction

This documentation provides all the information you will need to work with CITHAR ERP API. The application is built with Laravel 10 PHP framework & is systematically versioned (SEMVER).

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include a Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your access_token by logging in using the Login a user endpoint

Approval Endpoints

Display a listing of the Approvals for admin users.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/approvals?per_page=10" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/approvals"
);

const params = {
    "per_page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/approvals';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/approvals'
params = {
  'per_page': '10',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 12,
            "created_by": 3,
            "request_type": "leave",
            "request_model_id": 1,
            "total_required_approvers": 2,
            "status": "pending",
            "current_approver": 4,
            "current_approver_role": "hr level 1",
            "approved_details": [
                {
                    "remark": "fgfgjbhgbn",
                    "user_id": 4,
                    "signature": null,
                    "approved_date": "2024-03-05T10:22:36.399105Z",
                    "user_full_name": {
                        "last_name": "Mayer",
                        "first_name": "Ray",
                        "middle_name": "Macon Sexton"
                    }
                }
            ],
            "rejected_details": null,
            "approved_roles": [
                "supervisor level 1"
            ],
            "created_at": "2024-03-05T11:19:03.000000Z",
            "updated_at": "2024-03-05T11:22:36.000000Z",
            "deleted_at": null,
            "request_details": {
                "id": 1,
                "user_id": 3,
                "organization_id": 12,
                "start_date": "2024-03-06",
                "end_date": "2024-03-10",
                "type": "sick",
                "reason": "gffvhbjm",
                "number_of_days": "4",
                "created_at": "2024-03-05T11:19:02.000000Z",
                "updated_at": "2024-03-05T11:19:02.000000Z",
                "deleted_at": null
            }
        },
        {
            "id": 1,
            "organization_id": 12,
            "created_by": 3,
            "request_type": "leave",
            "request_model_id": 1,
            "total_required_approvers": 2,
            "status": "pending",
            "current_approver": 4,
            "current_approver_role": "hr level 1",
            "approved_details": [
                {
                    "remark": "fgfgjbhgbn",
                    "user_id": 4,
                    "signature": null,
                    "approved_date": "2024-03-05T10:22:36.399105Z",
                    "user_full_name": {
                        "last_name": "Mayer",
                        "first_name": "Ray",
                        "middle_name": "Macon Sexton"
                    }
                }
            ],
            "rejected_details": null,
            "approved_roles": [
                "supervisor level 1"
            ],
            "created_at": "2024-03-05T11:19:03.000000Z",
            "updated_at": "2024-03-05T11:22:36.000000Z",
            "deleted_at": null,
            "request_details": {
                "id": 1,
                "user_id": 3,
                "organization_id": 12,
                "start_date": "2024-03-06",
                "end_date": "2024-03-10",
                "type": "sick",
                "reason": "gffvhbjm",
                "number_of_days": "4",
                "created_at": "2024-03-05T11:19:02.000000Z",
                "updated_at": "2024-03-05T11:19:02.000000Z",
                "deleted_at": null
            }
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/approvals

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 10

POST api/approvals

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/approvals" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/approvals"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/approvals';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/approvals'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/approvals

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Show the specified Approval.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/approvals/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/approvals/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/approvals/3';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/approvals/3'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 12,
            "created_by": 3,
            "request_type": "leave",
            "request_model_id": 1,
            "total_required_approvers": 2,
            "status": "pending",
            "current_approver": 4,
            "current_approver_role": "hr level 1",
            "approved_details": [
                {
                    "remark": "fgfgjbhgbn",
                    "user_id": 4,
                    "signature": null,
                    "approved_date": "2024-03-05T10:22:36.399105Z",
                    "user_full_name": {
                        "last_name": "Mayer",
                        "first_name": "Ray",
                        "middle_name": "Macon Sexton"
                    }
                }
            ],
            "rejected_details": null,
            "approved_roles": [
                "supervisor level 1"
            ],
            "created_at": "2024-03-05T11:19:03.000000Z",
            "updated_at": "2024-03-05T11:22:36.000000Z",
            "deleted_at": null,
            "request_details": {
                "id": 1,
                "user_id": 3,
                "organization_id": 12,
                "start_date": "2024-03-06",
                "end_date": "2024-03-10",
                "type": "sick",
                "reason": "gffvhbjm",
                "number_of_days": "4",
                "created_at": "2024-03-05T11:19:02.000000Z",
                "updated_at": "2024-03-05T11:19:02.000000Z",
                "deleted_at": null
            }
        },
        {
            "id": 1,
            "organization_id": 12,
            "created_by": 3,
            "request_type": "leave",
            "request_model_id": 1,
            "total_required_approvers": 2,
            "status": "pending",
            "current_approver": 4,
            "current_approver_role": "hr level 1",
            "approved_details": [
                {
                    "remark": "fgfgjbhgbn",
                    "user_id": 4,
                    "signature": null,
                    "approved_date": "2024-03-05T10:22:36.399105Z",
                    "user_full_name": {
                        "last_name": "Mayer",
                        "first_name": "Ray",
                        "middle_name": "Macon Sexton"
                    }
                }
            ],
            "rejected_details": null,
            "approved_roles": [
                "supervisor level 1"
            ],
            "created_at": "2024-03-05T11:19:03.000000Z",
            "updated_at": "2024-03-05T11:22:36.000000Z",
            "deleted_at": null,
            "request_details": {
                "id": 1,
                "user_id": 3,
                "organization_id": 12,
                "start_date": "2024-03-06",
                "end_date": "2024-03-10",
                "type": "sick",
                "reason": "gffvhbjm",
                "number_of_days": "4",
                "created_at": "2024-03-05T11:19:02.000000Z",
                "updated_at": "2024-03-05T11:19:02.000000Z",
                "deleted_at": null
            }
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/approvals/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Approval Example: 3

Get a specified user for a request approval.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_approver" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"request_type\": \"retirement\",
    \"per_page\": 11
}"
const url = new URL(
    "https://api.cithar.com/api/get_approver"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "request_type": "retirement",
    "per_page": 11
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_approver';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'request_type' => 'retirement',
            'per_page' => 11,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_approver'
payload = {
    "request_type": "retirement",
    "per_page": 11
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_approver could not be found."
}
 

Request      

GET api/get_approver

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

request_type   string   

Example: retirement

Must be one of:
  • leave
  • requisition
  • retirement
  • timesheet
per_page   integer  optional  

Example: 11

Get a specified users to continue a request approval.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_next_approver" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"request_type\": \"retirement\",
    \"request_model_id\": 15
}"
const url = new URL(
    "https://api.cithar.com/api/get_next_approver"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "request_type": "retirement",
    "request_model_id": 15
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_next_approver';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'request_type' => 'retirement',
            'request_model_id' => 15,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_next_approver'
payload = {
    "request_type": "retirement",
    "request_model_id": 15
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_next_approver could not be found."
}
 

Request      

GET api/get_next_approver

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

request_type   string   

Example: retirement

Must be one of:
  • leave
  • requisition
  • retirement
  • timesheet
request_model_id   integer   

Example: 15

Get a list of request to be approved by a specific user.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_requested_approval" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"request_type\": \"retirement\",
    \"per_page\": 11
}"
const url = new URL(
    "https://api.cithar.com/api/get_requested_approval"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "request_type": "retirement",
    "per_page": 11
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_requested_approval';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'request_type' => 'retirement',
            'per_page' => 11,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_requested_approval'
payload = {
    "request_type": "retirement",
    "per_page": 11
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_requested_approval could not be found."
}
 

Request      

GET api/get_requested_approval

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

request_type   string   

Example: retirement

Must be one of:
  • leave
  • requisition
  • retirement
  • timesheet
per_page   integer  optional  

Example: 11

Get a list of approval request for a specific user.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/approve_reject" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"request_type\": \"requisition\",
    \"approver\": 14,
    \"approver_role\": \"id\",
    \"previous_approver_role\": \"et\",
    \"status\": \"approved\",
    \"remark\": \"inventore\",
    \"related_document\": \"voluptatibus\",
    \"report_document\": \"vitae\",
    \"request_model_id\": \"ratione\"
}"
const url = new URL(
    "https://api.cithar.com/api/approve_reject"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "request_type": "requisition",
    "approver": 14,
    "approver_role": "id",
    "previous_approver_role": "et",
    "status": "approved",
    "remark": "inventore",
    "related_document": "voluptatibus",
    "report_document": "vitae",
    "request_model_id": "ratione"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/approve_reject';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'request_type' => 'requisition',
            'approver' => 14,
            'approver_role' => 'id',
            'previous_approver_role' => 'et',
            'status' => 'approved',
            'remark' => 'inventore',
            'related_document' => 'voluptatibus',
            'report_document' => 'vitae',
            'request_model_id' => 'ratione',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/approve_reject'
payload = {
    "request_type": "requisition",
    "approver": 14,
    "approver_role": "id",
    "previous_approver_role": "et",
    "status": "approved",
    "remark": "inventore",
    "related_document": "voluptatibus",
    "report_document": "vitae",
    "request_model_id": "ratione"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/approve_reject

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

request_type   string   

Example: requisition

Must be one of:
  • leave
  • requisition
  • retirement
  • timesheet
approver   integer  optional  

The id of an existing record in the users table. Example: 14

approver_role   string  optional  

This field is required when approver is present. The name of an existing record in the roles table. Example: id

previous_approver_role   string  optional  

The name of an existing record in the roles table. Example: et

status   string  optional  

Example: approved

Must be one of:
  • approved
  • rejected
remark   string  optional  

Example: inventore

related_document   string  optional  

Example: voluptatibus

report_document   string  optional  

Example: vitae

request_model_id   string   

The request_model_id of an existing record in the approvals table. Example: ratione

Assets Endpoints

Display a listing of the Assets.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/assets?per_page=13&assigned_to=dolore" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/assets"
);

const params = {
    "per_page": "13",
    "assigned_to": "dolore",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '13',
            'assigned_to' => 'dolore',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets'
params = {
  'per_page': '13',
  'assigned_to': 'dolore',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "assigned_to": 4,
            "created_by": 3,
            "organization_id": 12,
            "project_id": 1,
            "description": "Sed id fugiat bland",
            "classification": "2",
            "acquisition_date": "2000-02-27",
            "disposal_date": "2020-11-15",
            "disposal_value": 1,
            "acquisition_value": 56,
            "fair_market_value": 67,
            "serial_number": "582",
            "lpo_number": "339",
            "invoice_number": "836",
            "model_number": "471",
            "vendor_name": "Rosalyn Yang",
            "life_span": "Nobis voluptas amet",
            "location_type": "Sit qui delectus e",
            "location_value": "Eligendi incidunt a",
            "condition": "Eiusmod sapiente ess",
            "received_note": "Eius et nostrum sed",
            "disposal_approval_donor": "Nostrum magni conseq",
            "disposal_approval_board": "Aut obcaecati laudan",
            "created_at": "2024-03-05T11:17:45.000000Z",
            "updated_at": "2024-03-05T11:17:45.000000Z",
            "deleted_at": null,
            "acquisition_value_local": null,
            "tag_name": "Sheila Mcdaniel",
            "created_by_user": {
                "first_name": "purityriordesign",
                "middle_name": null,
                "last_name": null
            },
            "assigned_to_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "project_name": "OVC"
        },
        {
            "id": 1,
            "assigned_to": 4,
            "created_by": 3,
            "organization_id": 12,
            "project_id": 1,
            "description": "Sed id fugiat bland",
            "classification": "2",
            "acquisition_date": "2000-02-27",
            "disposal_date": "2020-11-15",
            "disposal_value": 1,
            "acquisition_value": 56,
            "fair_market_value": 67,
            "serial_number": "582",
            "lpo_number": "339",
            "invoice_number": "836",
            "model_number": "471",
            "vendor_name": "Rosalyn Yang",
            "life_span": "Nobis voluptas amet",
            "location_type": "Sit qui delectus e",
            "location_value": "Eligendi incidunt a",
            "condition": "Eiusmod sapiente ess",
            "received_note": "Eius et nostrum sed",
            "disposal_approval_donor": "Nostrum magni conseq",
            "disposal_approval_board": "Aut obcaecati laudan",
            "created_at": "2024-03-05T11:17:45.000000Z",
            "updated_at": "2024-03-05T11:17:45.000000Z",
            "deleted_at": null,
            "acquisition_value_local": null,
            "tag_name": "Sheila Mcdaniel",
            "created_by_user": {
                "first_name": "purityriordesign",
                "middle_name": null,
                "last_name": null
            },
            "assigned_to_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "project_name": "OVC"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/assets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 13

assigned_to   string  optional  

assigned_to To filter request by User the Asset is assigned to (always required for specific user) Example: dolore

Store a new created Asset

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/assets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 10,
    \"organization_id\": 4,
    \"project_id\": 10,
    \"assigned_to\": 20,
    \"description\": \"Dolore facere sit est dolorem.\",
    \"classification\": \"non\",
    \"acquisition_date\": \"2026-01-25T16:32:31\",
    \"disposal_date\": \"2026-01-25T16:32:31\",
    \"disposal_value\": 16,
    \"acquisition_value\": 2,
    \"tag_name\": \"fuga\",
    \"acquisition_value_local\": 19,
    \"fair_market_value\": 16,
    \"serial_number\": \"at\",
    \"lpo_number\": \"culpa\",
    \"invoice_number\": \"quia\",
    \"model_number\": \"dolores\",
    \"vendor_name\": \"minima\",
    \"life_span\": \"et\",
    \"location_type\": \"inventore\",
    \"location_value\": \"adipisci\",
    \"condition\": \"et\",
    \"received_note\": \"porro\",
    \"disposal_approval_donor\": \"exercitationem\",
    \"disposal_approval_board\": \"unde\"
}"
const url = new URL(
    "https://api.cithar.com/api/assets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 10,
    "organization_id": 4,
    "project_id": 10,
    "assigned_to": 20,
    "description": "Dolore facere sit est dolorem.",
    "classification": "non",
    "acquisition_date": "2026-01-25T16:32:31",
    "disposal_date": "2026-01-25T16:32:31",
    "disposal_value": 16,
    "acquisition_value": 2,
    "tag_name": "fuga",
    "acquisition_value_local": 19,
    "fair_market_value": 16,
    "serial_number": "at",
    "lpo_number": "culpa",
    "invoice_number": "quia",
    "model_number": "dolores",
    "vendor_name": "minima",
    "life_span": "et",
    "location_type": "inventore",
    "location_value": "adipisci",
    "condition": "et",
    "received_note": "porro",
    "disposal_approval_donor": "exercitationem",
    "disposal_approval_board": "unde"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 10,
            'organization_id' => 4,
            'project_id' => 10,
            'assigned_to' => 20,
            'description' => 'Dolore facere sit est dolorem.',
            'classification' => 'non',
            'acquisition_date' => '2026-01-25T16:32:31',
            'disposal_date' => '2026-01-25T16:32:31',
            'disposal_value' => 16,
            'acquisition_value' => 2,
            'tag_name' => 'fuga',
            'acquisition_value_local' => 19,
            'fair_market_value' => 16,
            'serial_number' => 'at',
            'lpo_number' => 'culpa',
            'invoice_number' => 'quia',
            'model_number' => 'dolores',
            'vendor_name' => 'minima',
            'life_span' => 'et',
            'location_type' => 'inventore',
            'location_value' => 'adipisci',
            'condition' => 'et',
            'received_note' => 'porro',
            'disposal_approval_donor' => 'exercitationem',
            'disposal_approval_board' => 'unde',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets'
payload = {
    "created_by": 10,
    "organization_id": 4,
    "project_id": 10,
    "assigned_to": 20,
    "description": "Dolore facere sit est dolorem.",
    "classification": "non",
    "acquisition_date": "2026-01-25T16:32:31",
    "disposal_date": "2026-01-25T16:32:31",
    "disposal_value": 16,
    "acquisition_value": 2,
    "tag_name": "fuga",
    "acquisition_value_local": 19,
    "fair_market_value": 16,
    "serial_number": "at",
    "lpo_number": "culpa",
    "invoice_number": "quia",
    "model_number": "dolores",
    "vendor_name": "minima",
    "life_span": "et",
    "location_type": "inventore",
    "location_value": "adipisci",
    "condition": "et",
    "received_note": "porro",
    "disposal_approval_donor": "exercitationem",
    "disposal_approval_board": "unde"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "assigned_to": 4,
        "created_by": 3,
        "organization_id": 12,
        "project_id": 1,
        "description": "Sed id fugiat bland",
        "classification": "2",
        "acquisition_date": "2000-02-27",
        "disposal_date": "2020-11-15",
        "disposal_value": 1,
        "acquisition_value": 56,
        "fair_market_value": 67,
        "serial_number": "582",
        "lpo_number": "339",
        "invoice_number": "836",
        "model_number": "471",
        "vendor_name": "Rosalyn Yang",
        "life_span": "Nobis voluptas amet",
        "location_type": "Sit qui delectus e",
        "location_value": "Eligendi incidunt a",
        "condition": "Eiusmod sapiente ess",
        "received_note": "Eius et nostrum sed",
        "disposal_approval_donor": "Nostrum magni conseq",
        "disposal_approval_board": "Aut obcaecati laudan",
        "created_at": "2024-03-05T11:17:45.000000Z",
        "updated_at": "2024-03-05T11:17:45.000000Z",
        "deleted_at": null,
        "acquisition_value_local": null,
        "tag_name": "Sheila Mcdaniel",
        "created_by_user": {
            "first_name": "purityriordesign",
            "middle_name": null,
            "last_name": null
        },
        "assigned_to_user": {
            "first_name": "ernest",
            "middle_name": "shed",
            "last_name": "chidera"
        },
        "project_name": "OVC"
    }
}
 

Request      

POST api/assets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

created_by   integer   

The id of an existing record in the users table. Example: 10

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 4

project_id   integer  optional  

The id of an existing record in the projects table. Example: 10

assigned_to   integer  optional  

The id of an existing record in the users table. Example: 20

description   string   

Example: Dolore facere sit est dolorem.

classification   string   

Example: non

acquisition_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

disposal_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

disposal_value   integer  optional  

Example: 16

acquisition_value   integer   

Example: 2

tag_name   string   

Example: fuga

acquisition_value_local   integer  optional  

Example: 19

fair_market_value   integer  optional  

Example: 16

serial_number   string  optional  

Example: at

lpo_number   string  optional  

Example: culpa

invoice_number   string   

Example: quia

model_number   string   

Example: dolores

vendor_name   string   

Example: minima

life_span   string   

Example: et

location_type   string  optional  

Example: inventore

location_value   string  optional  

Example: adipisci

condition   string   

Example: et

received_note   string  optional  

Example: porro

disposal_approval_donor   string  optional  

Example: exercitationem

disposal_approval_board   string  optional  

Example: unde

Show a specified Asset.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/assets/12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/assets/12"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets/12';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets/12'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "assigned_to": 4,
        "created_by": 3,
        "organization_id": 12,
        "project_id": 1,
        "description": "Sed id fugiat bland",
        "classification": "2",
        "acquisition_date": "2000-02-27",
        "disposal_date": "2020-11-15",
        "disposal_value": 1,
        "acquisition_value": 56,
        "fair_market_value": 67,
        "serial_number": "582",
        "lpo_number": "339",
        "invoice_number": "836",
        "model_number": "471",
        "vendor_name": "Rosalyn Yang",
        "life_span": "Nobis voluptas amet",
        "location_type": "Sit qui delectus e",
        "location_value": "Eligendi incidunt a",
        "condition": "Eiusmod sapiente ess",
        "received_note": "Eius et nostrum sed",
        "disposal_approval_donor": "Nostrum magni conseq",
        "disposal_approval_board": "Aut obcaecati laudan",
        "created_at": "2024-03-05T11:17:45.000000Z",
        "updated_at": "2024-03-05T11:17:45.000000Z",
        "deleted_at": null,
        "acquisition_value_local": null,
        "tag_name": "Sheila Mcdaniel",
        "created_by_user": {
            "first_name": "purityriordesign",
            "middle_name": null,
            "last_name": null
        },
        "assigned_to_user": {
            "first_name": "ernest",
            "middle_name": "shed",
            "last_name": "chidera"
        },
        "project_name": "OVC"
    }
}
 

Request      

GET api/assets/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Asset Example: 12

Update the specified Asset.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/assets/18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"assigned_to\": 19,
    \"project_id\": 14,
    \"organization_id\": 11,
    \"description\": \"Excepturi dolores ut quisquam quia earum.\",
    \"classification\": \"qui\",
    \"acquisition_date\": \"2026-01-25T16:32:31\",
    \"disposal_date\": \"2026-01-25T16:32:31\",
    \"disposal_value\": 8,
    \"acquisition_value\": 2,
    \"fair_market_value\": 13,
    \"serial_number\": \"porro\",
    \"lpo_number\": \"aut\",
    \"tag_name\": \"doloribus\",
    \"acquisition_value_local\": \"aut\",
    \"invoice_number\": \"quos\",
    \"model_number\": \"ut\",
    \"vendor_name\": \"sunt\",
    \"life_span\": \"eos\",
    \"location_type\": \"dolorem\",
    \"location_value\": \"numquam\",
    \"condition\": \"dolor\",
    \"received_note\": \"vel\",
    \"disposal_approval_donor\": \"possimus\",
    \"disposal_approval_board\": \"enim\"
}"
const url = new URL(
    "https://api.cithar.com/api/assets/18"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "assigned_to": 19,
    "project_id": 14,
    "organization_id": 11,
    "description": "Excepturi dolores ut quisquam quia earum.",
    "classification": "qui",
    "acquisition_date": "2026-01-25T16:32:31",
    "disposal_date": "2026-01-25T16:32:31",
    "disposal_value": 8,
    "acquisition_value": 2,
    "fair_market_value": 13,
    "serial_number": "porro",
    "lpo_number": "aut",
    "tag_name": "doloribus",
    "acquisition_value_local": "aut",
    "invoice_number": "quos",
    "model_number": "ut",
    "vendor_name": "sunt",
    "life_span": "eos",
    "location_type": "dolorem",
    "location_value": "numquam",
    "condition": "dolor",
    "received_note": "vel",
    "disposal_approval_donor": "possimus",
    "disposal_approval_board": "enim"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets/18';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'assigned_to' => 19,
            'project_id' => 14,
            'organization_id' => 11,
            'description' => 'Excepturi dolores ut quisquam quia earum.',
            'classification' => 'qui',
            'acquisition_date' => '2026-01-25T16:32:31',
            'disposal_date' => '2026-01-25T16:32:31',
            'disposal_value' => 8,
            'acquisition_value' => 2,
            'fair_market_value' => 13,
            'serial_number' => 'porro',
            'lpo_number' => 'aut',
            'tag_name' => 'doloribus',
            'acquisition_value_local' => 'aut',
            'invoice_number' => 'quos',
            'model_number' => 'ut',
            'vendor_name' => 'sunt',
            'life_span' => 'eos',
            'location_type' => 'dolorem',
            'location_value' => 'numquam',
            'condition' => 'dolor',
            'received_note' => 'vel',
            'disposal_approval_donor' => 'possimus',
            'disposal_approval_board' => 'enim',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets/18'
payload = {
    "assigned_to": 19,
    "project_id": 14,
    "organization_id": 11,
    "description": "Excepturi dolores ut quisquam quia earum.",
    "classification": "qui",
    "acquisition_date": "2026-01-25T16:32:31",
    "disposal_date": "2026-01-25T16:32:31",
    "disposal_value": 8,
    "acquisition_value": 2,
    "fair_market_value": 13,
    "serial_number": "porro",
    "lpo_number": "aut",
    "tag_name": "doloribus",
    "acquisition_value_local": "aut",
    "invoice_number": "quos",
    "model_number": "ut",
    "vendor_name": "sunt",
    "life_span": "eos",
    "location_type": "dolorem",
    "location_value": "numquam",
    "condition": "dolor",
    "received_note": "vel",
    "disposal_approval_donor": "possimus",
    "disposal_approval_board": "enim"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "assigned_to": 4,
        "created_by": 3,
        "organization_id": 12,
        "project_id": 1,
        "description": "Sed id fugiat bland",
        "classification": "2",
        "acquisition_date": "2000-02-27",
        "disposal_date": "2020-11-15",
        "disposal_value": 1,
        "acquisition_value": 56,
        "fair_market_value": 67,
        "serial_number": "582",
        "lpo_number": "339",
        "invoice_number": "836",
        "model_number": "471",
        "vendor_name": "Rosalyn Yang",
        "life_span": "Nobis voluptas amet",
        "location_type": "Sit qui delectus e",
        "location_value": "Eligendi incidunt a",
        "condition": "Eiusmod sapiente ess",
        "received_note": "Eius et nostrum sed",
        "disposal_approval_donor": "Nostrum magni conseq",
        "disposal_approval_board": "Aut obcaecati laudan",
        "created_at": "2024-03-05T11:17:45.000000Z",
        "updated_at": "2024-03-05T11:17:45.000000Z",
        "deleted_at": null,
        "acquisition_value_local": null,
        "tag_name": "Sheila Mcdaniel",
        "created_by_user": {
            "first_name": "purityriordesign",
            "middle_name": null,
            "last_name": null
        },
        "assigned_to_user": {
            "first_name": "ernest",
            "middle_name": "shed",
            "last_name": "chidera"
        },
        "project_name": "OVC"
    }
}
 

Request      

PUT api/assets/{id}

PATCH api/assets/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Asset Example: 18

Body Parameters

assigned_to   integer  optional  

The id of an existing record in the users table. Example: 19

project_id   integer  optional  

The id of an existing record in the projects table. Example: 14

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 11

description   string  optional  

Example: Excepturi dolores ut quisquam quia earum.

classification   string  optional  

Example: qui

acquisition_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

disposal_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

disposal_value   integer  optional  

Example: 8

acquisition_value   integer  optional  

Example: 2

fair_market_value   integer  optional  

Example: 13

serial_number   string  optional  

Example: porro

lpo_number   string  optional  

Example: aut

tag_name   string  optional  

Example: doloribus

acquisition_value_local   string  optional  

Example: aut

invoice_number   string  optional  

Example: quos

model_number   string  optional  

Example: ut

vendor_name   string  optional  

Example: sunt

life_span   string  optional  

Example: eos

location_type   string  optional  

Example: dolorem

location_value   string  optional  

Example: numquam

condition   string  optional  

Example: dolor

received_note   string  optional  

Example: vel

disposal_approval_donor   string  optional  

Example: possimus

disposal_approval_board   string  optional  

Example: enim

Remove the specified Asset.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/assets/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/assets/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets/17';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets/17'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request      

DELETE api/assets/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Asset Example: 17

Get a logged-in user list of Assets.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_user_asset?per_page=14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/get_user_asset"
);

const params = {
    "per_page": "14",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_user_asset';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '14',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_user_asset'
params = {
  'per_page': '14',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_user_asset could not be found."
}
 

Request      

GET api/get_user_asset

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 14

Display a listing of the Assets Classifications.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/assets_classifications?term=omnis&per_page=11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/assets_classifications"
);

const params = {
    "term": "omnis",
    "per_page": "11",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets_classifications';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'term' => 'omnis',
            'per_page' => '11',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_classifications'
params = {
  'term': 'omnis',
  'per_page': '11',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 2,
            "organization_id": 12,
            "created_by": 3,
            "name": "it property",
            "description": "travel",
            "created_at": "2024-03-05T11:12:31.000000Z",
            "updated_at": "2024-03-05T11:12:31.000000Z",
            "deleted_at": null,
            "organization_name": "purityriordesign"
        },
        {
            "id": 2,
            "organization_id": 12,
            "created_by": 3,
            "name": "it property",
            "description": "travel",
            "created_at": "2024-03-05T11:12:31.000000Z",
            "updated_at": "2024-03-05T11:12:31.000000Z",
            "deleted_at": null,
            "organization_name": "purityriordesign"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/assets_classifications

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

term   string  optional  

Search query parameter for string data type Example: omnis

per_page   integer  optional  

Items per page Example: 11

Store a newly created Asset Classification.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/assets_classifications" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"dolores\",
    \"description\": \"Qui est et id asperiores ipsum repellendus.\",
    \"organization_id\": 2,
    \"created_by\": 15
}"
const url = new URL(
    "https://api.cithar.com/api/assets_classifications"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "dolores",
    "description": "Qui est et id asperiores ipsum repellendus.",
    "organization_id": 2,
    "created_by": 15
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets_classifications';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'dolores',
            'description' => 'Qui est et id asperiores ipsum repellendus.',
            'organization_id' => 2,
            'created_by' => 15,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_classifications'
payload = {
    "name": "dolores",
    "description": "Qui est et id asperiores ipsum repellendus.",
    "organization_id": 2,
    "created_by": 15
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 2,
        "organization_id": 12,
        "created_by": 3,
        "name": "it property",
        "description": "travel",
        "created_at": "2024-03-05T11:12:31.000000Z",
        "updated_at": "2024-03-05T11:12:31.000000Z",
        "deleted_at": null,
        "organization_name": "purityriordesign"
    }
}
 

Request      

POST api/assets_classifications

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: dolores

description   string  optional  

Example: Qui est et id asperiores ipsum repellendus.

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 2

created_by   integer   

The id of an existing record in the users table. Example: 15

Show the specified Assets Classification.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/assets_classifications/12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/assets_classifications/12"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets_classifications/12';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_classifications/12'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 2,
        "organization_id": 12,
        "created_by": 3,
        "name": "it property",
        "description": "travel",
        "created_at": "2024-03-05T11:12:31.000000Z",
        "updated_at": "2024-03-05T11:12:31.000000Z",
        "deleted_at": null,
        "organization_name": "purityriordesign"
    }
}
 

Request      

GET api/assets_classifications/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Asset Classification Example: 12

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/assets_classifications/5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"repudiandae\",
    \"description\": \"Ea aspernatur unde occaecati est temporibus.\",
    \"organization_id\": 8,
    \"created_by\": 6
}"
const url = new URL(
    "https://api.cithar.com/api/assets_classifications/5"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "repudiandae",
    "description": "Ea aspernatur unde occaecati est temporibus.",
    "organization_id": 8,
    "created_by": 6
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets_classifications/5';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'repudiandae',
            'description' => 'Ea aspernatur unde occaecati est temporibus.',
            'organization_id' => 8,
            'created_by' => 6,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_classifications/5'
payload = {
    "name": "repudiandae",
    "description": "Ea aspernatur unde occaecati est temporibus.",
    "organization_id": 8,
    "created_by": 6
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 2,
        "organization_id": 12,
        "created_by": 3,
        "name": "it property",
        "description": "travel",
        "created_at": "2024-03-05T11:12:31.000000Z",
        "updated_at": "2024-03-05T11:12:31.000000Z",
        "deleted_at": null,
        "organization_name": "purityriordesign"
    }
}
 

Request      

PUT api/assets_classifications/{id}

PATCH api/assets_classifications/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Asset Classification Example: 5

Body Parameters

name   string  optional  

Example: repudiandae

description   string  optional  

Example: Ea aspernatur unde occaecati est temporibus.

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 8

created_by   integer  optional  

The id of an existing record in the users table. Example: 6

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/assets_classifications/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/assets_classifications/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets_classifications/2';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_classifications/2'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 2,
        "organization_id": 12,
        "created_by": 3,
        "name": "it property",
        "description": "travel",
        "created_at": "2024-03-05T11:12:31.000000Z",
        "updated_at": "2024-03-05T11:12:31.000000Z",
        "deleted_at": null,
        "organization_name": "purityriordesign"
    }
}
 

Request      

DELETE api/assets_classifications/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Asset Classification Example: 2

Display a listing of the Assets Report.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/assets_reports?per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/assets_reports"
);

const params = {
    "per_page": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets_reports';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '15',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_reports'
params = {
  'per_page': '15',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "created_by_user": {
                "first_name": null,
                "middle_name": null,
                "last_name": null
            },
            "project_name": null
        },
        {
            "created_by_user": {
                "first_name": null,
                "middle_name": null,
                "last_name": null
            },
            "project_name": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/assets_reports

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 15

Store a newly created Asset Report.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/assets_reports" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 19,
    \"project_id\": 4,
    \"classification\": \"assumenda\",
    \"document\": \"azatamuhpwlukjr\",
    \"for_classification\": \"yes\",
    \"for_project\": \"no\"
}"
const url = new URL(
    "https://api.cithar.com/api/assets_reports"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 19,
    "project_id": 4,
    "classification": "assumenda",
    "document": "azatamuhpwlukjr",
    "for_classification": "yes",
    "for_project": "no"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets_reports';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'organization_id' => 19,
            'project_id' => 4,
            'classification' => 'assumenda',
            'document' => 'azatamuhpwlukjr',
            'for_classification' => 'yes',
            'for_project' => 'no',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_reports'
payload = {
    "organization_id": 19,
    "project_id": 4,
    "classification": "assumenda",
    "document": "azatamuhpwlukjr",
    "for_classification": "yes",
    "for_project": "no"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/assets_reports

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

organization_id   integer   

The id of an existing record in the organizations table. Example: 19

project_id   integer  optional  

This field is required when for_project is yes. The id of an existing record in the projects table. Example: 4

classification   string  optional  

This field is required when for_classification is yes. Example: assumenda

document   string  optional  

Must not be greater than 1024 characters. Example: azatamuhpwlukjr

for_classification   string   

Example: yes

Must be one of:
  • yes
  • no
for_project   string   

Example: no

Must be one of:
  • yes
  • no

Show a specified Assets Report.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/assets_reports/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/assets_reports/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets_reports/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_reports/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "created_by_user": {
            "first_name": null,
            "middle_name": null,
            "last_name": null
        },
        "project_name": null
    }
}
 

Request      

GET api/assets_reports/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Asset report Example: 1

Update the specified Assets Report.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/assets_reports/necessitatibus" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 8,
    \"project_id\": 2,
    \"created_by\": 20,
    \"classification\": \"qui\",
    \"details\": \"iste\",
    \"document\": \"gwlarnpsmmiyokokojak\",
    \"for_classification\": \"no\",
    \"for_project\": \"no\"
}"
const url = new URL(
    "https://api.cithar.com/api/assets_reports/necessitatibus"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 8,
    "project_id": 2,
    "created_by": 20,
    "classification": "qui",
    "details": "iste",
    "document": "gwlarnpsmmiyokokojak",
    "for_classification": "no",
    "for_project": "no"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets_reports/necessitatibus';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'organization_id' => 8,
            'project_id' => 2,
            'created_by' => 20,
            'classification' => 'qui',
            'details' => 'iste',
            'document' => 'gwlarnpsmmiyokokojak',
            'for_classification' => 'no',
            'for_project' => 'no',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_reports/necessitatibus'
payload = {
    "organization_id": 8,
    "project_id": 2,
    "created_by": 20,
    "classification": "qui",
    "details": "iste",
    "document": "gwlarnpsmmiyokokojak",
    "for_classification": "no",
    "for_project": "no"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "created_by_user": {
            "first_name": null,
            "middle_name": null,
            "last_name": null
        },
        "project_name": null
    }
}
 

Request      

PUT api/assets_reports/{id}

PATCH api/assets_reports/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the assets report. Example: necessitatibus

Body Parameters

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 8

project_id   integer  optional  

This field is required when for_project is yes. The id of an existing record in the projects table. Example: 2

created_by   integer  optional  

The id of an existing record in the users table. Example: 20

classification   string  optional  

This field is required when for_classification is yes. Example: qui

details   string  optional  

Example: iste

document   string  optional  

Must not be greater than 1024 characters. Example: gwlarnpsmmiyokokojak

for_classification   string  optional  

Example: no

Must be one of:
  • yes
  • no
for_project   string  optional  

Example: no

Must be one of:
  • yes
  • no

Remove the specified Asset Report.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/assets_reports/excepturi" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/assets_reports/excepturi"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/assets_reports/excepturi';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_reports/excepturi'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "created_by_user": {
            "first_name": null,
            "middle_name": null,
            "last_name": null
        },
        "project_name": null
    }
}
 

Request      

DELETE api/assets_reports/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the assets report. Example: excepturi

Authenticate Endpoints

Login a user

Example request:
curl --request POST \
    "https://api.cithar.com/api/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "client_id: The application client ID provided by the SSO application" \
    --header "client_secret: The application client secret key provided by the SSO application" \
    --data "{
    \"email\": \"qcartwright@example.org\",
    \"password\": \"Igx)@S$d-oRb&1!Zy\"
}"
const url = new URL(
    "https://api.cithar.com/api/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "client_id": "The application client ID provided by the SSO application",
    "client_secret": "The application client secret key provided by the SSO application",
};

let body = {
    "email": "qcartwright@example.org",
    "password": "Igx)@S$d-oRb&1!Zy"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/login';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'client_id' => 'The application client ID provided by the SSO application',
            'client_secret' => 'The application client secret key provided by the SSO application',
        ],
        'json' => [
            'email' => 'qcartwright@example.org',
            'password' => 'Igx)@S$d-oRb&1!Zy',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/login'
payload = {
    "email": "qcartwright@example.org",
    "password": "Igx)@S$d-oRb&1!Zy"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'client_id': 'The application client ID provided by the SSO application',
  'client_secret': 'The application client secret key provided by the SSO application'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "message": "Login was successful",
    "data": {
        "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.....",
        "user": {
            "id": 1,
            "email": "victorhills42@gmail.com",
            "active": 1,
            "organization_id": 1,
            "is_profile_updated": 0,
            "email_verified_at": "2023-07-03T15:28:11.000000Z",
            "created_at": "2023-07-03T15:28:11.000000Z",
            "updated_at": "2023-07-03T15:28:11.000000Z",
            "deleted_at": null,
            "profile_details": null,
            "user_organization": {
                "id": 1,
                "name": "SSDO",
                "email": "ssdo@ssdo.com",
                "phone_number": "09053003200"
            },
            "organization_subscription_plan": {
                "id": 1,
                "payment_reference": 26252625,
                "start_date": "2023-07-03",
                "end_date": "2024-12-21"
            },
            "projects": [
                {
                    "id": 1,
                    "name": "ssdo",
                    "summary": "ssdos",
                    "funder": "ssdos",
                    "category": "sscaa"
                }
            ],
            "roles": [
                {
                    "id": 1,
                    "name": "admin"
                },
                {
                    "id": 2,
                    "name": "nass"
                }
            ]
        }
    }
}
 

Request      

POST api/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

client_id      

Example: The application client ID provided by the SSO application

client_secret      

Example: The application client secret key provided by the SSO application

Body Parameters

email   string   

The email of the user Example: qcartwright@example.org

password   string   

The password of the user Example: Igx)@S$d-oRb&1!Zy

Reset user password

Example request:
curl --request POST \
    "https://api.cithar.com/api/reset_password?email=adrain14%40example.com" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"domenica.franecki@example.org\"
}"
const url = new URL(
    "https://api.cithar.com/api/reset_password"
);

const params = {
    "email": "adrain14@example.com",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "domenica.franecki@example.org"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/reset_password';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'email' => 'adrain14@example.com',
        ],
        'json' => [
            'email' => 'domenica.franecki@example.org',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/reset_password'
payload = {
    "email": "domenica.franecki@example.org"
}
params = {
  'email': 'adrain14@example.com',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload, params=params)
response.json()

Request      

POST api/reset_password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

email   string   

The user email Example: adrain14@example.com

Body Parameters

email   string   

Must be a valid email address. The email of an existing record in the users table. Example: domenica.franecki@example.org

POST api/test

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/test" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/test"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/test';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/test'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/test

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Create new user and assign roles and permissions

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/create_user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"recusandae\",
    \"middle_name\": \"voluptatem\",
    \"last_name\": \"dolores\",
    \"designation\": \"tempora\",
    \"staff_id\": \"quos\",
    \"email\": \"alena41@example.org\",
    \"organization_id\": 6,
    \"roles\": [
        \"fuga\"
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/create_user"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "recusandae",
    "middle_name": "voluptatem",
    "last_name": "dolores",
    "designation": "tempora",
    "staff_id": "quos",
    "email": "alena41@example.org",
    "organization_id": 6,
    "roles": [
        "fuga"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/create_user';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'first_name' => 'recusandae',
            'middle_name' => 'voluptatem',
            'last_name' => 'dolores',
            'designation' => 'tempora',
            'staff_id' => 'quos',
            'email' => 'alena41@example.org',
            'organization_id' => 6,
            'roles' => [
                'fuga',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/create_user'
payload = {
    "first_name": "recusandae",
    "middle_name": "voluptatem",
    "last_name": "dolores",
    "designation": "tempora",
    "staff_id": "quos",
    "email": "alena41@example.org",
    "organization_id": 6,
    "roles": [
        "fuga"
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/create_user

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

first_name   string   

Example: recusandae

middle_name   string   

Example: voluptatem

last_name   string   

Example: dolores

designation   string   

Example: tempora

staff_id   string   

Example: quos

email   string   

Must be a valid email address. Example: alena41@example.org

organization_id   integer   

The id of an existing record in the organizations table. Example: 6

roles   string[]  optional  

The name of an existing record in the roles table.

Show the list of roles.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_roles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/get_roles"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_roles';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_roles'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_roles could not be found."
}
 

Request      

GET api/get_roles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Update authenticated in user password

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/update_password?password=h-%5C%5B%23%27e" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"current_password\": \"aut\",
    \"new_password\": \"et\"
}"
const url = new URL(
    "https://api.cithar.com/api/update_password"
);

const params = {
    "password": "h-\[#'e",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "current_password": "aut",
    "new_password": "et"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/update_password';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'password' => 'h-\[#'e',
        ],
        'json' => [
            'current_password' => 'aut',
            'new_password' => 'et',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/update_password'
payload = {
    "current_password": "aut",
    "new_password": "et"
}
params = {
  'password': 'h-\[#'e',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload, params=params)
response.json()

Request      

POST api/update_password

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

password   string   

The user's new password Example: h-\[#'e

Body Parameters

current_password   string   

Example: aut

new_password   string   

The value and current_password must be different. Example: et

Finance Endpoints

Display a listing of the Requisition for admin users.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/requisitions?per_page=6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/requisitions"
);

const params = {
    "per_page": "6",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/requisitions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '6',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/requisitions'
params = {
  'per_page': '6',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 7,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "title": "development",
            "activity_type": "1",
            "description": "Mollit amet qui atq",
            "type": null,
            "start_date": "2024-03-05",
            "end_date": "2024-03-06",
            "created_at": "2024-03-05T11:48:49.000000Z",
            "updated_at": "2024-03-05T11:48:49.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "activity_name": "training",
            "project_name": "OVC",
            "project_funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "cost_items": [
                {
                    "id": 7,
                    "cost_title": "development",
                    "unit_price": "3000",
                    "quantity": 1,
                    "no_of_persons": 1,
                    "total": "3000",
                    "oca": null,
                    "pca": null,
                    "frequency_of_occurrence": "1",
                    "justification": "Omnis aspernatur sun",
                    "parent_id": null
                }
            ],
            "beneficiaries_details": [
                {
                    "id": 1,
                    "amount": "3000",
                    "bank_name": "Access Bank",
                    "account_number": "0059848490",
                    "account_name": "SHEDRACH CHIDERA ERNEST",
                    "bank_sort_code": "044",
                    "serial_number": null,
                    "narration": "repair of uju's laptop, the screen was touching without click"
                }
            ],
            "sum_total": 3000,
            "approval_details": {
                "total_required_approvers": 3,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "finance level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "hwrhgnk",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:49:16.787786Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        },
        {
            "id": 7,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "title": "development",
            "activity_type": "1",
            "description": "Mollit amet qui atq",
            "type": null,
            "start_date": "2024-03-05",
            "end_date": "2024-03-06",
            "created_at": "2024-03-05T11:48:49.000000Z",
            "updated_at": "2024-03-05T11:48:49.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "activity_name": "training",
            "project_name": "OVC",
            "project_funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "cost_items": [
                {
                    "id": 7,
                    "cost_title": "development",
                    "unit_price": "3000",
                    "quantity": 1,
                    "no_of_persons": 1,
                    "total": "3000",
                    "oca": null,
                    "pca": null,
                    "frequency_of_occurrence": "1",
                    "justification": "Omnis aspernatur sun",
                    "parent_id": null
                }
            ],
            "beneficiaries_details": [
                {
                    "id": 1,
                    "amount": "3000",
                    "bank_name": "Access Bank",
                    "account_number": "0059848490",
                    "account_name": "SHEDRACH CHIDERA ERNEST",
                    "bank_sort_code": "044",
                    "serial_number": null,
                    "narration": "repair of uju's laptop, the screen was touching without click"
                }
            ],
            "sum_total": 3000,
            "approval_details": {
                "total_required_approvers": 3,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "finance level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "hwrhgnk",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:49:16.787786Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/requisitions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 6

Store a newly created Requisition.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/requisitions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 8,
    \"approver\": 20,
    \"approver_role\": \"facere\",
    \"organization_id\": 7,
    \"project_id\": 6,
    \"title\": \"ut\",
    \"type\": \"cash\",
    \"activity_type\": \"illum\",
    \"description\": \"Est soluta ut ab.\",
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2026-01-25T16:32:31\",
    \"cost_items\": [
        {
            \"cost_title\": \"totam\",
            \"unit_price\": \"et\",
            \"quantity\": 17,
            \"no_of_persons\": 15,
            \"total\": \"atque\",
            \"oca\": 16,
            \"pca\": 15,
            \"frequency_of_occurrence\": \"commodi\",
            \"justification\": \"natus\"
        }
    ],
    \"beneficiaries_details\": [
        {
            \"amount\": \"eum\",
            \"bank_name\": \"eos\",
            \"account_number\": \"rerum\",
            \"account_name\": \"est\",
            \"bank_sort_code\": \"aliquid\",
            \"serial_number\": 15,
            \"narration\": \"impedit\"
        }
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/requisitions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 8,
    "approver": 20,
    "approver_role": "facere",
    "organization_id": 7,
    "project_id": 6,
    "title": "ut",
    "type": "cash",
    "activity_type": "illum",
    "description": "Est soluta ut ab.",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31",
    "cost_items": [
        {
            "cost_title": "totam",
            "unit_price": "et",
            "quantity": 17,
            "no_of_persons": 15,
            "total": "atque",
            "oca": 16,
            "pca": 15,
            "frequency_of_occurrence": "commodi",
            "justification": "natus"
        }
    ],
    "beneficiaries_details": [
        {
            "amount": "eum",
            "bank_name": "eos",
            "account_number": "rerum",
            "account_name": "est",
            "bank_sort_code": "aliquid",
            "serial_number": 15,
            "narration": "impedit"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/requisitions';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 8,
            'approver' => 20,
            'approver_role' => 'facere',
            'organization_id' => 7,
            'project_id' => 6,
            'title' => 'ut',
            'type' => 'cash',
            'activity_type' => 'illum',
            'description' => 'Est soluta ut ab.',
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2026-01-25T16:32:31',
            'cost_items' => [
                [
                    'cost_title' => 'totam',
                    'unit_price' => 'et',
                    'quantity' => 17,
                    'no_of_persons' => 15,
                    'total' => 'atque',
                    'oca' => 16,
                    'pca' => 15,
                    'frequency_of_occurrence' => 'commodi',
                    'justification' => 'natus',
                ],
            ],
            'beneficiaries_details' => [
                [
                    'amount' => 'eum',
                    'bank_name' => 'eos',
                    'account_number' => 'rerum',
                    'account_name' => 'est',
                    'bank_sort_code' => 'aliquid',
                    'serial_number' => 15,
                    'narration' => 'impedit',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/requisitions'
payload = {
    "created_by": 8,
    "approver": 20,
    "approver_role": "facere",
    "organization_id": 7,
    "project_id": 6,
    "title": "ut",
    "type": "cash",
    "activity_type": "illum",
    "description": "Est soluta ut ab.",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31",
    "cost_items": [
        {
            "cost_title": "totam",
            "unit_price": "et",
            "quantity": 17,
            "no_of_persons": 15,
            "total": "atque",
            "oca": 16,
            "pca": 15,
            "frequency_of_occurrence": "commodi",
            "justification": "natus"
        }
    ],
    "beneficiaries_details": [
        {
            "amount": "eum",
            "bank_name": "eos",
            "account_number": "rerum",
            "account_name": "est",
            "bank_sort_code": "aliquid",
            "serial_number": 15,
            "narration": "impedit"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 7,
        "created_by": 4,
        "organization_id": 12,
        "project_id": 1,
        "title": "development",
        "activity_type": "1",
        "description": "Mollit amet qui atq",
        "type": null,
        "start_date": "2024-03-05",
        "end_date": "2024-03-06",
        "created_at": "2024-03-05T11:48:49.000000Z",
        "updated_at": "2024-03-05T11:48:49.000000Z",
        "deleted_at": null,
        "created_by_user": {
            "first_name": "ernest",
            "middle_name": "shed",
            "last_name": "chidera"
        },
        "activity_name": "training",
        "project_name": "OVC",
        "project_funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
        "cost_items": [
            {
                "id": 7,
                "cost_title": "development",
                "unit_price": "3000",
                "quantity": 1,
                "no_of_persons": 1,
                "total": "3000",
                "oca": null,
                "pca": null,
                "frequency_of_occurrence": "1",
                "justification": "Omnis aspernatur sun",
                "parent_id": null
            }
        ],
        "beneficiaries_details": [
            {
                "id": 1,
                "amount": "3000",
                "bank_name": "Access Bank",
                "account_number": "0059848490",
                "account_name": "SHEDRACH CHIDERA ERNEST",
                "bank_sort_code": "044",
                "serial_number": null,
                "narration": "repair of uju's laptop, the screen was touching without click"
            }
        ],
        "sum_total": 3000,
        "approval_details": {
            "total_required_approvers": 3,
            "status": "pending",
            "current_approver": 4,
            "current_approver_role": "finance level 1",
            "current_approver_full_name": [
                {
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                }
            ],
            "approved_details": [
                {
                    "remark": "hwrhgnk",
                    "user_id": 4,
                    "signature": null,
                    "approved_date": "2024-03-05T10:49:16.787786Z",
                    "user_full_name": {
                        "last_name": "Mayer",
                        "first_name": "Ray",
                        "middle_name": "Macon Sexton"
                    }
                }
            ],
            "rejected_details": null
        }
    }
}
 

Request      

POST api/requisitions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

created_by   integer   

The id of an existing record in the users table. Example: 8

approver   integer   

The id of an existing record in the users table. Example: 20

approver_role   string   

The name of an existing record in the roles table. Example: facere

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 7

project_id   integer  optional  

The id of an existing record in the projects table. Example: 6

title   string   

Example: ut

type   string  optional  

Example: cash

Must be one of:
  • bank_transfer
  • cash
activity_type   string   

Example: illum

description   string   

Example: Est soluta ut ab.

start_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

cost_items   object[]   
cost_title   string   

Example: totam

unit_price   string   

Example: et

quantity   integer   

Example: 17

no_of_persons   integer   

Example: 15

total   string   

Example: atque

oca   integer  optional  

Example: 16

pca   integer  optional  

Example: 15

frequency_of_occurrence   string  optional  

Example: commodi

justification   string  optional  

Example: natus

beneficiaries_details   object[]  optional  
amount   string  optional  

Example: eum

bank_name   string  optional  

Example: eos

account_number   string  optional  

Example: rerum

account_name   string  optional  

Example: est

bank_sort_code   string  optional  

Example: aliquid

serial_number   integer  optional  

Example: 15

narration   string   

Example: impedit

Show the specified Requisition.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/requisitions/14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/requisitions/14"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/requisitions/14';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/requisitions/14'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 7,
        "created_by": 4,
        "organization_id": 12,
        "project_id": 1,
        "title": "development",
        "activity_type": "1",
        "description": "Mollit amet qui atq",
        "type": null,
        "start_date": "2024-03-05",
        "end_date": "2024-03-06",
        "created_at": "2024-03-05T11:48:49.000000Z",
        "updated_at": "2024-03-05T11:48:49.000000Z",
        "deleted_at": null,
        "created_by_user": {
            "first_name": "ernest",
            "middle_name": "shed",
            "last_name": "chidera"
        },
        "activity_name": "training",
        "project_name": "OVC",
        "project_funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
        "cost_items": [
            {
                "id": 7,
                "cost_title": "development",
                "unit_price": "3000",
                "quantity": 1,
                "no_of_persons": 1,
                "total": "3000",
                "oca": null,
                "pca": null,
                "frequency_of_occurrence": "1",
                "justification": "Omnis aspernatur sun",
                "parent_id": null
            }
        ],
        "beneficiaries_details": [
            {
                "id": 1,
                "amount": "3000",
                "bank_name": "Access Bank",
                "account_number": "0059848490",
                "account_name": "SHEDRACH CHIDERA ERNEST",
                "bank_sort_code": "044",
                "serial_number": null,
                "narration": "repair of uju's laptop, the screen was touching without click"
            }
        ],
        "sum_total": 3000,
        "approval_details": {
            "total_required_approvers": 3,
            "status": "pending",
            "current_approver": 4,
            "current_approver_role": "finance level 1",
            "current_approver_full_name": [
                {
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                }
            ],
            "approved_details": [
                {
                    "remark": "hwrhgnk",
                    "user_id": 4,
                    "signature": null,
                    "approved_date": "2024-03-05T10:49:16.787786Z",
                    "user_full_name": {
                        "last_name": "Mayer",
                        "first_name": "Ray",
                        "middle_name": "Macon Sexton"
                    }
                }
            ],
            "rejected_details": null
        }
    }
}
 

Request      

GET api/requisitions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Requisition Example: 14

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/requisitions/sint" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 8,
    \"approver\": 3,
    \"approver_role\": \"quam\",
    \"organization_id\": 3,
    \"project_id\": 9,
    \"title\": \"minus\",
    \"type\": \"cash\",
    \"activity_type\": \"est\",
    \"description\": \"Nihil sint explicabo fugiat sed et sed dolor.\",
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2026-01-25T16:32:31\",
    \"cost_items\": [
        {
            \"id\": 7,
            \"cost_title\": \"quidem\",
            \"unit_price\": \"odio\",
            \"quantity\": 6,
            \"no_of_persons\": 11,
            \"total\": \"beatae\",
            \"oca\": 7,
            \"pca\": 6,
            \"frequency_of_occurrence\": \"ea\",
            \"justification\": \"itaque\"
        }
    ],
    \"beneficiaries_details\": [
        {
            \"id\": 2,
            \"amount\": \"quisquam\",
            \"bank_name\": \"optio\",
            \"account_number\": \"aperiam\",
            \"account_name\": \"nesciunt\",
            \"bank_sort_code\": \"ratione\",
            \"serial_number\": 19,
            \"narration\": \"et\"
        }
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/requisitions/sint"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 8,
    "approver": 3,
    "approver_role": "quam",
    "organization_id": 3,
    "project_id": 9,
    "title": "minus",
    "type": "cash",
    "activity_type": "est",
    "description": "Nihil sint explicabo fugiat sed et sed dolor.",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31",
    "cost_items": [
        {
            "id": 7,
            "cost_title": "quidem",
            "unit_price": "odio",
            "quantity": 6,
            "no_of_persons": 11,
            "total": "beatae",
            "oca": 7,
            "pca": 6,
            "frequency_of_occurrence": "ea",
            "justification": "itaque"
        }
    ],
    "beneficiaries_details": [
        {
            "id": 2,
            "amount": "quisquam",
            "bank_name": "optio",
            "account_number": "aperiam",
            "account_name": "nesciunt",
            "bank_sort_code": "ratione",
            "serial_number": 19,
            "narration": "et"
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/requisitions/sint';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 8,
            'approver' => 3,
            'approver_role' => 'quam',
            'organization_id' => 3,
            'project_id' => 9,
            'title' => 'minus',
            'type' => 'cash',
            'activity_type' => 'est',
            'description' => 'Nihil sint explicabo fugiat sed et sed dolor.',
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2026-01-25T16:32:31',
            'cost_items' => [
                [
                    'id' => 7,
                    'cost_title' => 'quidem',
                    'unit_price' => 'odio',
                    'quantity' => 6,
                    'no_of_persons' => 11,
                    'total' => 'beatae',
                    'oca' => 7,
                    'pca' => 6,
                    'frequency_of_occurrence' => 'ea',
                    'justification' => 'itaque',
                ],
            ],
            'beneficiaries_details' => [
                [
                    'id' => 2,
                    'amount' => 'quisquam',
                    'bank_name' => 'optio',
                    'account_number' => 'aperiam',
                    'account_name' => 'nesciunt',
                    'bank_sort_code' => 'ratione',
                    'serial_number' => 19,
                    'narration' => 'et',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/requisitions/sint'
payload = {
    "created_by": 8,
    "approver": 3,
    "approver_role": "quam",
    "organization_id": 3,
    "project_id": 9,
    "title": "minus",
    "type": "cash",
    "activity_type": "est",
    "description": "Nihil sint explicabo fugiat sed et sed dolor.",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31",
    "cost_items": [
        {
            "id": 7,
            "cost_title": "quidem",
            "unit_price": "odio",
            "quantity": 6,
            "no_of_persons": 11,
            "total": "beatae",
            "oca": 7,
            "pca": 6,
            "frequency_of_occurrence": "ea",
            "justification": "itaque"
        }
    ],
    "beneficiaries_details": [
        {
            "id": 2,
            "amount": "quisquam",
            "bank_name": "optio",
            "account_number": "aperiam",
            "account_name": "nesciunt",
            "bank_sort_code": "ratione",
            "serial_number": 19,
            "narration": "et"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request      

PUT api/requisitions/{id}

PATCH api/requisitions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the requisition. Example: sint

Body Parameters

created_by   integer  optional  

The id of an existing record in the users table. Example: 8

approver   integer  optional  

The id of an existing record in the users table. Example: 3

approver_role   string  optional  

The name of an existing record in the roles table. Example: quam

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 3

project_id   integer  optional  

The id of an existing record in the projects table. Example: 9

title   string  optional  

Example: minus

type   string  optional  

Example: cash

Must be one of:
  • bank_transfer
  • cash
activity_type   string  optional  

Example: est

description   string  optional  

Example: Nihil sint explicabo fugiat sed et sed dolor.

start_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

cost_items   object[]  optional  
id   integer  optional  

The id of an existing record in the cost_items table. Example: 7

cost_title   string   

Example: quidem

unit_price   string  optional  

Example: odio

quantity   integer  optional  

Example: 6

no_of_persons   integer  optional  

Example: 11

total   string  optional  

Example: beatae

oca   integer  optional  

Example: 7

pca   integer  optional  

Example: 6

frequency_of_occurrence   string  optional  

Example: ea

justification   string  optional  

Example: itaque

beneficiaries_details   object[]  optional  
id   integer  optional  

The id of an existing record in the beneficiaries_detail table. Example: 2

amount   string  optional  

Example: quisquam

bank_name   string  optional  

Example: optio

account_number   string  optional  

Example: aperiam

account_name   string   

Example: nesciunt

bank_sort_code   string  optional  

Example: ratione

serial_number   integer  optional  

Example: 19

narration   string  optional  

Example: et

Display a listing of the Retirements for admin roles.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/retirements?per_page=2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/retirements"
);

const params = {
    "per_page": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/retirements';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/retirements'
params = {
  'per_page': '2',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "requisition_id": 7,
            "organization_id": 12,
            "project_id": 1,
            "created_by": 4,
            "related_document": "https://res.cloudinary.com/citharerp/image/upload/v1709635839/mobile-2510529_1280_cetmo7.jpg",
            "report_document": null,
            "payment_voucher": null,
            "cost_items": [
                7
            ],
            "beneficiaries": null,
            "created_at": "2024-03-05T11:50:40.000000Z",
            "updated_at": "2024-03-05T11:50:40.000000Z",
            "deleted_at": null,
            "project_name": "OVC",
            "project_funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "requisition": {
                "id": 7,
                "created_by": 4,
                "organization_id": 12,
                "project_id": 1,
                "title": "development",
                "activity_type": "1",
                "description": "Mollit amet qui atq",
                "type": null,
                "start_date": "2024-03-05",
                "end_date": "2024-03-06",
                "created_at": "2024-03-05T11:48:49.000000Z",
                "updated_at": "2024-03-05T11:48:49.000000Z",
                "deleted_at": null,
                "created_by_user": {
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                },
                "activity_name": "training",
                "project_name": "OVC",
                "project_funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
                "cost_items": [
                    {
                        "id": 7,
                        "cost_title": "development",
                        "unit_price": "3000",
                        "quantity": 1,
                        "no_of_persons": 1,
                        "total": "3000",
                        "oca": null,
                        "pca": null,
                        "frequency_of_occurrence": "1",
                        "justification": "Omnis aspernatur sun",
                        "parent_id": null
                    }
                ],
                "beneficiaries_details": [
                    {
                        "id": 1,
                        "amount": "3000",
                        "bank_name": "Access Bank",
                        "account_number": "0059848490",
                        "account_name": "SHEDRACH CHIDERA ERNEST",
                        "bank_sort_code": "044",
                        "serial_number": null,
                        "narration": "repair of uju's laptop, the screen was touching without click"
                    }
                ],
                "sum_total": 3000,
                "approval_details": {
                    "total_required_approvers": 3,
                    "status": "pending",
                    "current_approver": 4,
                    "current_approver_role": "finance level 1",
                    "current_approver_full_name": [
                        {
                            "first_name": "ernest",
                            "middle_name": "shed",
                            "last_name": "chidera"
                        }
                    ],
                    "approved_details": [
                        {
                            "remark": "hwrhgnk",
                            "user_id": 4,
                            "signature": null,
                            "approved_date": "2024-03-05T10:49:16.787786Z",
                            "user_full_name": {
                                "last_name": "Mayer",
                                "first_name": "Ray",
                                "middle_name": "Macon Sexton"
                            }
                        }
                    ],
                    "rejected_details": null
                }
            },
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "cost_items_details": [
                {
                    "id": 7,
                    "requisition_id": 7,
                    "created_by": 4,
                    "organization_id": 12,
                    "project_id": 1,
                    "cost_title": "development",
                    "unit_price": "3000",
                    "quantity": 1,
                    "no_of_persons": 1,
                    "total": "3000",
                    "oca": null,
                    "pca": null,
                    "frequency_of_occurrence": "1",
                    "justification": "Omnis aspernatur sun",
                    "created_at": "2024-03-05T11:48:49.000000Z",
                    "updated_at": "2024-03-05T11:48:49.000000Z",
                    "deleted_at": null,
                    "parent_id": null
                }
            ],
            "cost_items_update_details": [],
            "sum_total": 3000,
            "is_editable": false,
            "approval_details": {
                "total_required_approvers": 3,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "finance level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "gfgjhnkm",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:51:01.406811Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        },
        {
            "id": 1,
            "requisition_id": 7,
            "organization_id": 12,
            "project_id": 1,
            "created_by": 4,
            "related_document": "https://res.cloudinary.com/citharerp/image/upload/v1709635839/mobile-2510529_1280_cetmo7.jpg",
            "report_document": null,
            "payment_voucher": null,
            "cost_items": [
                7
            ],
            "beneficiaries": null,
            "created_at": "2024-03-05T11:50:40.000000Z",
            "updated_at": "2024-03-05T11:50:40.000000Z",
            "deleted_at": null,
            "project_name": "OVC",
            "project_funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "requisition": {
                "id": 7,
                "created_by": 4,
                "organization_id": 12,
                "project_id": 1,
                "title": "development",
                "activity_type": "1",
                "description": "Mollit amet qui atq",
                "type": null,
                "start_date": "2024-03-05",
                "end_date": "2024-03-06",
                "created_at": "2024-03-05T11:48:49.000000Z",
                "updated_at": "2024-03-05T11:48:49.000000Z",
                "deleted_at": null,
                "created_by_user": {
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                },
                "activity_name": "training",
                "project_name": "OVC",
                "project_funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
                "cost_items": [
                    {
                        "id": 7,
                        "cost_title": "development",
                        "unit_price": "3000",
                        "quantity": 1,
                        "no_of_persons": 1,
                        "total": "3000",
                        "oca": null,
                        "pca": null,
                        "frequency_of_occurrence": "1",
                        "justification": "Omnis aspernatur sun",
                        "parent_id": null
                    }
                ],
                "beneficiaries_details": [
                    {
                        "id": 1,
                        "amount": "3000",
                        "bank_name": "Access Bank",
                        "account_number": "0059848490",
                        "account_name": "SHEDRACH CHIDERA ERNEST",
                        "bank_sort_code": "044",
                        "serial_number": null,
                        "narration": "repair of uju's laptop, the screen was touching without click"
                    }
                ],
                "sum_total": 3000,
                "approval_details": {
                    "total_required_approvers": 3,
                    "status": "pending",
                    "current_approver": 4,
                    "current_approver_role": "finance level 1",
                    "current_approver_full_name": [
                        {
                            "first_name": "ernest",
                            "middle_name": "shed",
                            "last_name": "chidera"
                        }
                    ],
                    "approved_details": [
                        {
                            "remark": "hwrhgnk",
                            "user_id": 4,
                            "signature": null,
                            "approved_date": "2024-03-05T10:49:16.787786Z",
                            "user_full_name": {
                                "last_name": "Mayer",
                                "first_name": "Ray",
                                "middle_name": "Macon Sexton"
                            }
                        }
                    ],
                    "rejected_details": null
                }
            },
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "cost_items_details": [
                {
                    "id": 7,
                    "requisition_id": 7,
                    "created_by": 4,
                    "organization_id": 12,
                    "project_id": 1,
                    "cost_title": "development",
                    "unit_price": "3000",
                    "quantity": 1,
                    "no_of_persons": 1,
                    "total": "3000",
                    "oca": null,
                    "pca": null,
                    "frequency_of_occurrence": "1",
                    "justification": "Omnis aspernatur sun",
                    "created_at": "2024-03-05T11:48:49.000000Z",
                    "updated_at": "2024-03-05T11:48:49.000000Z",
                    "deleted_at": null,
                    "parent_id": null
                }
            ],
            "cost_items_update_details": [],
            "sum_total": 3000,
            "is_editable": false,
            "approval_details": {
                "total_required_approvers": 3,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "finance level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "gfgjhnkm",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:51:01.406811Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/retirements

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 2

Store a newly created Retirement.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/retirements" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"requisition_id\": 2,
    \"organization_id\": 1,
    \"project_id\": 2,
    \"created_by\": 2,
    \"approver\": 18,
    \"approver_role\": \"similique\",
    \"related_document\": \"nostrum\",
    \"report_document\": \"iste\",
    \"cost_items\": [
        2
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/retirements"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "requisition_id": 2,
    "organization_id": 1,
    "project_id": 2,
    "created_by": 2,
    "approver": 18,
    "approver_role": "similique",
    "related_document": "nostrum",
    "report_document": "iste",
    "cost_items": [
        2
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/retirements';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'requisition_id' => 2,
            'organization_id' => 1,
            'project_id' => 2,
            'created_by' => 2,
            'approver' => 18,
            'approver_role' => 'similique',
            'related_document' => 'nostrum',
            'report_document' => 'iste',
            'cost_items' => [
                2,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/retirements'
payload = {
    "requisition_id": 2,
    "organization_id": 1,
    "project_id": 2,
    "created_by": 2,
    "approver": 18,
    "approver_role": "similique",
    "related_document": "nostrum",
    "report_document": "iste",
    "cost_items": [
        2
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "requisition_id": 7,
        "organization_id": 12,
        "project_id": 1,
        "created_by": 4,
        "related_document": "https://res.cloudinary.com/citharerp/image/upload/v1709635839/mobile-2510529_1280_cetmo7.jpg",
        "report_document": null,
        "payment_voucher": null,
        "cost_items": [
            7
        ],
        "beneficiaries": null,
        "created_at": "2024-03-05T11:50:40.000000Z",
        "updated_at": "2024-03-05T11:50:40.000000Z",
        "deleted_at": null,
        "project_name": "OVC",
        "project_funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
        "requisition": {
            "id": 7,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "title": "development",
            "activity_type": "1",
            "description": "Mollit amet qui atq",
            "type": null,
            "start_date": "2024-03-05",
            "end_date": "2024-03-06",
            "created_at": "2024-03-05T11:48:49.000000Z",
            "updated_at": "2024-03-05T11:48:49.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "activity_name": "training",
            "project_name": "OVC",
            "project_funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "cost_items": [
                {
                    "id": 7,
                    "cost_title": "development",
                    "unit_price": "3000",
                    "quantity": 1,
                    "no_of_persons": 1,
                    "total": "3000",
                    "oca": null,
                    "pca": null,
                    "frequency_of_occurrence": "1",
                    "justification": "Omnis aspernatur sun",
                    "parent_id": null
                }
            ],
            "beneficiaries_details": [
                {
                    "id": 1,
                    "amount": "3000",
                    "bank_name": "Access Bank",
                    "account_number": "0059848490",
                    "account_name": "SHEDRACH CHIDERA ERNEST",
                    "bank_sort_code": "044",
                    "serial_number": null,
                    "narration": "repair of uju's laptop, the screen was touching without click"
                }
            ],
            "sum_total": 3000,
            "approval_details": {
                "total_required_approvers": 3,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "finance level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "hwrhgnk",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:49:16.787786Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        },
        "created_by_user": {
            "first_name": "ernest",
            "middle_name": "shed",
            "last_name": "chidera"
        },
        "cost_items_details": [
            {
                "id": 7,
                "requisition_id": 7,
                "created_by": 4,
                "organization_id": 12,
                "project_id": 1,
                "cost_title": "development",
                "unit_price": "3000",
                "quantity": 1,
                "no_of_persons": 1,
                "total": "3000",
                "oca": null,
                "pca": null,
                "frequency_of_occurrence": "1",
                "justification": "Omnis aspernatur sun",
                "created_at": "2024-03-05T11:48:49.000000Z",
                "updated_at": "2024-03-05T11:48:49.000000Z",
                "deleted_at": null,
                "parent_id": null
            }
        ],
        "cost_items_update_details": [],
        "sum_total": 3000,
        "is_editable": false,
        "approval_details": {
            "total_required_approvers": 3,
            "status": "pending",
            "current_approver": 4,
            "current_approver_role": "finance level 1",
            "current_approver_full_name": [
                {
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                }
            ],
            "approved_details": [
                {
                    "remark": "gfgjhnkm",
                    "user_id": 4,
                    "signature": null,
                    "approved_date": "2024-03-05T10:51:01.406811Z",
                    "user_full_name": {
                        "last_name": "Mayer",
                        "first_name": "Ray",
                        "middle_name": "Macon Sexton"
                    }
                }
            ],
            "rejected_details": null
        }
    }
}
 

Request      

POST api/retirements

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

requisition_id   integer   

The id of an existing record in the requisitions table. Example: 2

organization_id   integer   

The id of an existing record in the organizations table. Example: 1

project_id   integer   

The id of an existing record in the projects table. Example: 2

created_by   integer   

The id of an existing record in the users table. Example: 2

approver   integer  optional  

The id of an existing record in the users table. Example: 18

approver_role   string  optional  

The name of an existing record in the roles table. Example: similique

related_document   string  optional  

Example: nostrum

report_document   string  optional  

Example: iste

cost_items   integer[]  optional  

The id of an existing record in the cost_items table.

Show the specified retirement.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/retirements/id" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/retirements/id"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/retirements/id';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/retirements/id'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "requisition_id": 7,
        "organization_id": 12,
        "project_id": 1,
        "created_by": 4,
        "related_document": "https://res.cloudinary.com/citharerp/image/upload/v1709635839/mobile-2510529_1280_cetmo7.jpg",
        "report_document": null,
        "payment_voucher": null,
        "cost_items": [
            7
        ],
        "beneficiaries": null,
        "created_at": "2024-03-05T11:50:40.000000Z",
        "updated_at": "2024-03-05T11:50:40.000000Z",
        "deleted_at": null,
        "project_name": "OVC",
        "project_funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
        "requisition": {
            "id": 7,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "title": "development",
            "activity_type": "1",
            "description": "Mollit amet qui atq",
            "type": null,
            "start_date": "2024-03-05",
            "end_date": "2024-03-06",
            "created_at": "2024-03-05T11:48:49.000000Z",
            "updated_at": "2024-03-05T11:48:49.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "activity_name": "training",
            "project_name": "OVC",
            "project_funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "cost_items": [
                {
                    "id": 7,
                    "cost_title": "development",
                    "unit_price": "3000",
                    "quantity": 1,
                    "no_of_persons": 1,
                    "total": "3000",
                    "oca": null,
                    "pca": null,
                    "frequency_of_occurrence": "1",
                    "justification": "Omnis aspernatur sun",
                    "parent_id": null
                }
            ],
            "beneficiaries_details": [
                {
                    "id": 1,
                    "amount": "3000",
                    "bank_name": "Access Bank",
                    "account_number": "0059848490",
                    "account_name": "SHEDRACH CHIDERA ERNEST",
                    "bank_sort_code": "044",
                    "serial_number": null,
                    "narration": "repair of uju's laptop, the screen was touching without click"
                }
            ],
            "sum_total": 3000,
            "approval_details": {
                "total_required_approvers": 3,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "finance level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "hwrhgnk",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:49:16.787786Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        },
        "created_by_user": {
            "first_name": "ernest",
            "middle_name": "shed",
            "last_name": "chidera"
        },
        "cost_items_details": [
            {
                "id": 7,
                "requisition_id": 7,
                "created_by": 4,
                "organization_id": 12,
                "project_id": 1,
                "cost_title": "development",
                "unit_price": "3000",
                "quantity": 1,
                "no_of_persons": 1,
                "total": "3000",
                "oca": null,
                "pca": null,
                "frequency_of_occurrence": "1",
                "justification": "Omnis aspernatur sun",
                "created_at": "2024-03-05T11:48:49.000000Z",
                "updated_at": "2024-03-05T11:48:49.000000Z",
                "deleted_at": null,
                "parent_id": null
            }
        ],
        "cost_items_update_details": [],
        "sum_total": 3000,
        "is_editable": false,
        "approval_details": {
            "total_required_approvers": 3,
            "status": "pending",
            "current_approver": 4,
            "current_approver_role": "finance level 1",
            "current_approver_full_name": [
                {
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                }
            ],
            "approved_details": [
                {
                    "remark": "gfgjhnkm",
                    "user_id": 4,
                    "signature": null,
                    "approved_date": "2024-03-05T10:51:01.406811Z",
                    "user_full_name": {
                        "last_name": "Mayer",
                        "first_name": "Ray",
                        "middle_name": "Macon Sexton"
                    }
                }
            ],
            "rejected_details": null
        }
    }
}
 

Request      

GET api/retirements/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the retirement. Example: id

Update the specified retirement.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/retirements/quia" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"request_type\": \"retirement\",
    \"approver\": 16,
    \"approver_role\": \"repellendus\",
    \"previous_approver_role\": \"iure\",
    \"status\": \"approved\",
    \"remark\": \"dolores\",
    \"related_document\": \"id\",
    \"report_document\": \"accusamus\",
    \"request_model_id\": \"veniam\"
}"
const url = new URL(
    "https://api.cithar.com/api/retirements/quia"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "request_type": "retirement",
    "approver": 16,
    "approver_role": "repellendus",
    "previous_approver_role": "iure",
    "status": "approved",
    "remark": "dolores",
    "related_document": "id",
    "report_document": "accusamus",
    "request_model_id": "veniam"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/retirements/quia';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'request_type' => 'retirement',
            'approver' => 16,
            'approver_role' => 'repellendus',
            'previous_approver_role' => 'iure',
            'status' => 'approved',
            'remark' => 'dolores',
            'related_document' => 'id',
            'report_document' => 'accusamus',
            'request_model_id' => 'veniam',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/retirements/quia'
payload = {
    "request_type": "retirement",
    "approver": 16,
    "approver_role": "repellendus",
    "previous_approver_role": "iure",
    "status": "approved",
    "remark": "dolores",
    "related_document": "id",
    "report_document": "accusamus",
    "request_model_id": "veniam"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request      

PUT api/retirements/{id}

PATCH api/retirements/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the retirement. Example: quia

Body Parameters

request_type   string   

Example: retirement

Must be one of:
  • leave
  • requisition
  • retirement
  • timesheet
approver   integer  optional  

The id of an existing record in the users table. Example: 16

approver_role   string  optional  

This field is required when approver is present. The name of an existing record in the roles table. Example: repellendus

previous_approver_role   string  optional  

The name of an existing record in the roles table. Example: iure

status   string  optional  

Example: approved

Must be one of:
  • approved
  • rejected
remark   string  optional  

Example: dolores

related_document   string  optional  

Example: id

report_document   string  optional  

Example: accusamus

request_model_id   string   

The request_model_id of an existing record in the approvals table. Example: veniam

Display a listing of the Banks.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/banks?per_page=2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/banks"
);

const params = {
    "per_page": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/banks';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/banks'
params = {
  'per_page': '2',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/banks could not be found."
}
 

Request      

GET api/banks

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 2

Validate a give Bank Account.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/banks?account_number=15&bank_code=13" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/banks"
);

const params = {
    "account_number": "15",
    "bank_code": "13",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/banks';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'account_number' => '15',
            'bank_code' => '13',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/banks'
params = {
  'account_number': '15',
  'bank_code': '13',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, params=params)
response.json()

Request      

POST api/banks

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

account_number   integer  optional  

the account number Example: 15

bank_code   integer  optional  

the selected bank code Example: 13

Get a logged-in user list of approved Retirements.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_user_requisitions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/get_user_requisitions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_user_requisitions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_user_requisitions'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_user_requisitions could not be found."
}
 

Request      

GET api/get_user_requisitions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get a logged-in user list of Requisitions.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_user_retirements" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/get_user_retirements"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_user_retirements';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_user_retirements'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_user_retirements could not be found."
}
 

Request      

GET api/get_user_retirements

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Update the Cost items from a requisition in storage.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/update_cost_item" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"requisition_id\": 6,
    \"organization_id\": 6,
    \"project_id\": 15,
    \"created_by\": 17,
    \"cost_title\": \"et\",
    \"unit_price\": \"aut\",
    \"quantity\": 19,
    \"no_of_persons\": 18,
    \"total\": \"sed\",
    \"oca\": \"magni\",
    \"pca\": \"repellat\",
    \"frequency_of_occurrence\": \"excepturi\",
    \"justification\": \"ipsum\",
    \"parent_id\": 2
}"
const url = new URL(
    "https://api.cithar.com/api/update_cost_item"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "requisition_id": 6,
    "organization_id": 6,
    "project_id": 15,
    "created_by": 17,
    "cost_title": "et",
    "unit_price": "aut",
    "quantity": 19,
    "no_of_persons": 18,
    "total": "sed",
    "oca": "magni",
    "pca": "repellat",
    "frequency_of_occurrence": "excepturi",
    "justification": "ipsum",
    "parent_id": 2
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/update_cost_item';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'requisition_id' => 6,
            'organization_id' => 6,
            'project_id' => 15,
            'created_by' => 17,
            'cost_title' => 'et',
            'unit_price' => 'aut',
            'quantity' => 19,
            'no_of_persons' => 18,
            'total' => 'sed',
            'oca' => 'magni',
            'pca' => 'repellat',
            'frequency_of_occurrence' => 'excepturi',
            'justification' => 'ipsum',
            'parent_id' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/update_cost_item'
payload = {
    "requisition_id": 6,
    "organization_id": 6,
    "project_id": 15,
    "created_by": 17,
    "cost_title": "et",
    "unit_price": "aut",
    "quantity": 19,
    "no_of_persons": 18,
    "total": "sed",
    "oca": "magni",
    "pca": "repellat",
    "frequency_of_occurrence": "excepturi",
    "justification": "ipsum",
    "parent_id": 2
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/update_cost_item

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

requisition_id   integer   

The id of an existing record in the requisitions table. Example: 6

organization_id   integer   

The id of an existing record in the organizations table. Example: 6

project_id   integer   

The id of an existing record in the projects table. Example: 15

created_by   integer   

The id of an existing record in the users table. Example: 17

cost_title   string   

Example: et

unit_price   string   

Example: aut

quantity   integer   

Example: 19

no_of_persons   integer   

Example: 18

total   string   

Example: sed

oca   string  optional  

Example: magni

pca   string  optional  

Example: repellat

frequency_of_occurrence   string  optional  

Example: excepturi

justification   string  optional  

Example: ipsum

parent_id   integer   

The id of an existing record in the cost_items table. Example: 2

Create a new Cost item from a retirement.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/create_cost_item" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"requisition_id\": 10,
    \"organization_id\": 15,
    \"project_id\": 13,
    \"created_by\": 16,
    \"cost_title\": \"qui\",
    \"unit_price\": \"quod\",
    \"quantity\": 6,
    \"no_of_persons\": 4,
    \"total\": \"neque\",
    \"oca\": \"hic\",
    \"pca\": \"ut\",
    \"frequency_of_occurrence\": \"illum\",
    \"justification\": \"numquam\",
    \"parent_id\": 4
}"
const url = new URL(
    "https://api.cithar.com/api/create_cost_item"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "requisition_id": 10,
    "organization_id": 15,
    "project_id": 13,
    "created_by": 16,
    "cost_title": "qui",
    "unit_price": "quod",
    "quantity": 6,
    "no_of_persons": 4,
    "total": "neque",
    "oca": "hic",
    "pca": "ut",
    "frequency_of_occurrence": "illum",
    "justification": "numquam",
    "parent_id": 4
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/create_cost_item';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'requisition_id' => 10,
            'organization_id' => 15,
            'project_id' => 13,
            'created_by' => 16,
            'cost_title' => 'qui',
            'unit_price' => 'quod',
            'quantity' => 6,
            'no_of_persons' => 4,
            'total' => 'neque',
            'oca' => 'hic',
            'pca' => 'ut',
            'frequency_of_occurrence' => 'illum',
            'justification' => 'numquam',
            'parent_id' => 4,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/create_cost_item'
payload = {
    "requisition_id": 10,
    "organization_id": 15,
    "project_id": 13,
    "created_by": 16,
    "cost_title": "qui",
    "unit_price": "quod",
    "quantity": 6,
    "no_of_persons": 4,
    "total": "neque",
    "oca": "hic",
    "pca": "ut",
    "frequency_of_occurrence": "illum",
    "justification": "numquam",
    "parent_id": 4
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/create_cost_item

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

requisition_id   integer  optional  

The id of an existing record in the requisitions table. Example: 10

organization_id   integer   

The id of an existing record in the organizations table. Example: 15

project_id   integer   

The id of an existing record in the projects table. Example: 13

created_by   integer   

The id of an existing record in the users table. Example: 16

cost_title   string   

Example: qui

unit_price   string   

Example: quod

quantity   integer   

Example: 6

no_of_persons   integer   

Example: 4

total   string   

Example: neque

oca   string  optional  

Example: hic

pca   string  optional  

Example: ut

frequency_of_occurrence   string  optional  

Example: illum

justification   string  optional  

Example: numquam

parent_id   integer  optional  

The id of an existing record in the cost_items table. Example: 4

Get a logged-in user list of Requisitions for creating a Retirement.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_requisition_retirement" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/get_requisition_retirement"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_requisition_retirement';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_requisition_retirement'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_requisition_retirement could not be found."
}
 

Request      

GET api/get_requisition_retirement

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Display a listing of the Accounts.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/accounts?per_page=3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/accounts"
);

const params = {
    "per_page": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/accounts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/accounts'
params = {
  'per_page': '3',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 6,
            "created_by": 24,
            "organization_id": 12,
            "project_id": 6,
            "account_number": "59848490",
            "account_name": "SHEDRACH CHIDERA ERNEST",
            "bank_name": "Access Bank",
            "amount": "220000000.08",
            "created_at": "2024-03-20T18:27:36.000000Z",
            "updated_at": "2024-04-23T12:04:48.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "jennifer",
                "middle_name": "Galvin Hall",
                "last_name": "Ugwuanyi"
            },
            "project": "wash",
            "project_funder": "caritas"
        },
        {
            "id": 6,
            "created_by": 24,
            "organization_id": 12,
            "project_id": 6,
            "account_number": "59848490",
            "account_name": "SHEDRACH CHIDERA ERNEST",
            "bank_name": "Access Bank",
            "amount": "220000000.08",
            "created_at": "2024-03-20T18:27:36.000000Z",
            "updated_at": "2024-04-23T12:04:48.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "jennifer",
                "middle_name": "Galvin Hall",
                "last_name": "Ugwuanyi"
            },
            "project": "wash",
            "project_funder": "caritas"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/accounts

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 3

Store a newly created Account.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/accounts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 8,
    \"organization_id\": 18,
    \"project_id\": 11,
    \"account_name\": \"magnam\",
    \"account_number\": 20,
    \"amount\": \"pariatur\",
    \"bank_name\": \"blanditiis\"
}"
const url = new URL(
    "https://api.cithar.com/api/accounts"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 8,
    "organization_id": 18,
    "project_id": 11,
    "account_name": "magnam",
    "account_number": 20,
    "amount": "pariatur",
    "bank_name": "blanditiis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/accounts';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 8,
            'organization_id' => 18,
            'project_id' => 11,
            'account_name' => 'magnam',
            'account_number' => 20,
            'amount' => 'pariatur',
            'bank_name' => 'blanditiis',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/accounts'
payload = {
    "created_by": 8,
    "organization_id": 18,
    "project_id": 11,
    "account_name": "magnam",
    "account_number": 20,
    "amount": "pariatur",
    "bank_name": "blanditiis"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 6,
            "created_by": 24,
            "organization_id": 12,
            "project_id": 6,
            "account_number": "59848490",
            "account_name": "SHEDRACH CHIDERA ERNEST",
            "bank_name": "Access Bank",
            "amount": "220000000.08",
            "created_at": "2024-03-20T18:27:36.000000Z",
            "updated_at": "2024-04-23T12:04:48.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "jennifer",
                "middle_name": "Galvin Hall",
                "last_name": "Ugwuanyi"
            },
            "project": "wash",
            "project_funder": "caritas"
        },
        {
            "id": 6,
            "created_by": 24,
            "organization_id": 12,
            "project_id": 6,
            "account_number": "59848490",
            "account_name": "SHEDRACH CHIDERA ERNEST",
            "bank_name": "Access Bank",
            "amount": "220000000.08",
            "created_at": "2024-03-20T18:27:36.000000Z",
            "updated_at": "2024-04-23T12:04:48.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "jennifer",
                "middle_name": "Galvin Hall",
                "last_name": "Ugwuanyi"
            },
            "project": "wash",
            "project_funder": "caritas"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

POST api/accounts

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

created_by   integer   

The id of an existing record in the users table. Example: 8

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 18

project_id   integer   

The id of an existing record in the projects table. Example: 11

account_name   string   

Example: magnam

account_number   integer   

Example: 20

amount   string   

Example: pariatur

bank_name   string   

Example: blanditiis

Show the specified Account.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/accounts/minima" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/accounts/minima"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/accounts/minima';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/accounts/minima'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 6,
            "created_by": 24,
            "organization_id": 12,
            "project_id": 6,
            "account_number": "59848490",
            "account_name": "SHEDRACH CHIDERA ERNEST",
            "bank_name": "Access Bank",
            "amount": "220000000.08",
            "created_at": "2024-03-20T18:27:36.000000Z",
            "updated_at": "2024-04-23T12:04:48.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "jennifer",
                "middle_name": "Galvin Hall",
                "last_name": "Ugwuanyi"
            },
            "project": "wash",
            "project_funder": "caritas"
        },
        {
            "id": 6,
            "created_by": 24,
            "organization_id": 12,
            "project_id": 6,
            "account_number": "59848490",
            "account_name": "SHEDRACH CHIDERA ERNEST",
            "bank_name": "Access Bank",
            "amount": "220000000.08",
            "created_at": "2024-03-20T18:27:36.000000Z",
            "updated_at": "2024-04-23T12:04:48.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "jennifer",
                "middle_name": "Galvin Hall",
                "last_name": "Ugwuanyi"
            },
            "project": "wash",
            "project_funder": "caritas"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/accounts/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the account. Example: minima

Update the specified Account.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/accounts/fugit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 7,
    \"organization_id\": 17,
    \"project_id\": 10,
    \"account_name\": \"qui\",
    \"account_number\": 15,
    \"bank_name\": \"ab\"
}"
const url = new URL(
    "https://api.cithar.com/api/accounts/fugit"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 7,
    "organization_id": 17,
    "project_id": 10,
    "account_name": "qui",
    "account_number": 15,
    "bank_name": "ab"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/accounts/fugit';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 7,
            'organization_id' => 17,
            'project_id' => 10,
            'account_name' => 'qui',
            'account_number' => 15,
            'bank_name' => 'ab',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/accounts/fugit'
payload = {
    "created_by": 7,
    "organization_id": 17,
    "project_id": 10,
    "account_name": "qui",
    "account_number": 15,
    "bank_name": "ab"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 6,
            "created_by": 24,
            "organization_id": 12,
            "project_id": 6,
            "account_number": "59848490",
            "account_name": "SHEDRACH CHIDERA ERNEST",
            "bank_name": "Access Bank",
            "amount": "220000000.08",
            "created_at": "2024-03-20T18:27:36.000000Z",
            "updated_at": "2024-04-23T12:04:48.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "jennifer",
                "middle_name": "Galvin Hall",
                "last_name": "Ugwuanyi"
            },
            "project": "wash",
            "project_funder": "caritas"
        },
        {
            "id": 6,
            "created_by": 24,
            "organization_id": 12,
            "project_id": 6,
            "account_number": "59848490",
            "account_name": "SHEDRACH CHIDERA ERNEST",
            "bank_name": "Access Bank",
            "amount": "220000000.08",
            "created_at": "2024-03-20T18:27:36.000000Z",
            "updated_at": "2024-04-23T12:04:48.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "jennifer",
                "middle_name": "Galvin Hall",
                "last_name": "Ugwuanyi"
            },
            "project": "wash",
            "project_funder": "caritas"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

PUT api/accounts/{id}

PATCH api/accounts/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the account. Example: fugit

Body Parameters

created_by   integer  optional  

The id of an existing record in the users table. Example: 7

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 17

project_id   integer  optional  

The id of an existing record in the projects table. Example: 10

account_name   string  optional  

Example: qui

account_number   integer  optional  

Example: 15

amount   string  optional  
bank_name   string  optional  

Example: ab

Remove the specified Account.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/accounts/ea" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/accounts/ea"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/accounts/ea';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/accounts/ea'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 6,
            "created_by": 24,
            "organization_id": 12,
            "project_id": 6,
            "account_number": "59848490",
            "account_name": "SHEDRACH CHIDERA ERNEST",
            "bank_name": "Access Bank",
            "amount": "220000000.08",
            "created_at": "2024-03-20T18:27:36.000000Z",
            "updated_at": "2024-04-23T12:04:48.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "jennifer",
                "middle_name": "Galvin Hall",
                "last_name": "Ugwuanyi"
            },
            "project": "wash",
            "project_funder": "caritas"
        },
        {
            "id": 6,
            "created_by": 24,
            "organization_id": 12,
            "project_id": 6,
            "account_number": "59848490",
            "account_name": "SHEDRACH CHIDERA ERNEST",
            "bank_name": "Access Bank",
            "amount": "220000000.08",
            "created_at": "2024-03-20T18:27:36.000000Z",
            "updated_at": "2024-04-23T12:04:48.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "jennifer",
                "middle_name": "Galvin Hall",
                "last_name": "Ugwuanyi"
            },
            "project": "wash",
            "project_funder": "caritas"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

DELETE api/accounts/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the account. Example: ea

Display a listing of the Account Transactions.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/account_transactions?per_page=6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/account_transactions"
);

const params = {
    "per_page": "6",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/account_transactions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '6',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/account_transactions'
params = {
  'per_page': '6',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "created_by": 6,
            "organization_id": 13,
            "project_id": 10,
            "account_id": 14,
            "retirement_id": null,
            "cost_item_id": null,
            "amount": "4000000",
            "justification": "FUnds received for disbursement",
            "type": "inflow",
            "created_at": "2024-05-09T12:11:01.000000Z",
            "updated_at": "2024-05-09T12:11:01.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "Udoamaka",
                "middle_name": "Chidimma",
                "last_name": "Okoye"
            },
            "cost_item": null,
            "project_name": "Jacob's Well"
        },
        {
            "id": 1,
            "created_by": 6,
            "organization_id": 13,
            "project_id": 10,
            "account_id": 14,
            "retirement_id": null,
            "cost_item_id": null,
            "amount": "4000000",
            "justification": "FUnds received for disbursement",
            "type": "inflow",
            "created_at": "2024-05-09T12:11:01.000000Z",
            "updated_at": "2024-05-09T12:11:01.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "Udoamaka",
                "middle_name": "Chidimma",
                "last_name": "Okoye"
            },
            "cost_item": null,
            "project_name": "Jacob's Well"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/account_transactions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 6

Store a newly created Account Transactions.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/account_transactions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 15,
    \"organization_id\": 18,
    \"project_id\": 16,
    \"account_id\": 17,
    \"amount\": \"molestias\",
    \"justification\": \"iure\",
    \"type\": \"inflow\",
    \"requisition_id\": 2,
    \"retirement_id\": 15,
    \"cost_title\": \"modi\",
    \"unit_price\": \"rerum\",
    \"quantity\": 5,
    \"no_of_persons\": 5,
    \"total\": \"dolore\",
    \"oca\": 17,
    \"pca\": 4,
    \"frequency_of_occurrence\": \"quasi\"
}"
const url = new URL(
    "https://api.cithar.com/api/account_transactions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 15,
    "organization_id": 18,
    "project_id": 16,
    "account_id": 17,
    "amount": "molestias",
    "justification": "iure",
    "type": "inflow",
    "requisition_id": 2,
    "retirement_id": 15,
    "cost_title": "modi",
    "unit_price": "rerum",
    "quantity": 5,
    "no_of_persons": 5,
    "total": "dolore",
    "oca": 17,
    "pca": 4,
    "frequency_of_occurrence": "quasi"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/account_transactions';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 15,
            'organization_id' => 18,
            'project_id' => 16,
            'account_id' => 17,
            'amount' => 'molestias',
            'justification' => 'iure',
            'type' => 'inflow',
            'requisition_id' => 2,
            'retirement_id' => 15,
            'cost_title' => 'modi',
            'unit_price' => 'rerum',
            'quantity' => 5,
            'no_of_persons' => 5,
            'total' => 'dolore',
            'oca' => 17,
            'pca' => 4,
            'frequency_of_occurrence' => 'quasi',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/account_transactions'
payload = {
    "created_by": 15,
    "organization_id": 18,
    "project_id": 16,
    "account_id": 17,
    "amount": "molestias",
    "justification": "iure",
    "type": "inflow",
    "requisition_id": 2,
    "retirement_id": 15,
    "cost_title": "modi",
    "unit_price": "rerum",
    "quantity": 5,
    "no_of_persons": 5,
    "total": "dolore",
    "oca": 17,
    "pca": 4,
    "frequency_of_occurrence": "quasi"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 7,
            "requisition_id": 7,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "cost_title": "development",
            "unit_price": "3000",
            "quantity": 1,
            "no_of_persons": 1,
            "total": "3000",
            "oca": null,
            "pca": null,
            "frequency_of_occurrence": "1",
            "justification": "Omnis aspernatur sun",
            "created_at": "2024-03-05T11:48:49.000000Z",
            "updated_at": "2024-03-05T11:48:49.000000Z",
            "deleted_at": null,
            "parent_id": null,
            "created_by_user": {
                "first_name": null,
                "middle_name": null,
                "last_name": null
            },
            "cost_item": null,
            "project_name": "OVC"
        },
        {
            "id": 7,
            "requisition_id": 7,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "cost_title": "development",
            "unit_price": "3000",
            "quantity": 1,
            "no_of_persons": 1,
            "total": "3000",
            "oca": null,
            "pca": null,
            "frequency_of_occurrence": "1",
            "justification": "Omnis aspernatur sun",
            "created_at": "2024-03-05T11:48:49.000000Z",
            "updated_at": "2024-03-05T11:48:49.000000Z",
            "deleted_at": null,
            "parent_id": null,
            "created_by_user": {
                "first_name": null,
                "middle_name": null,
                "last_name": null
            },
            "cost_item": null,
            "project_name": "OVC"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

POST api/account_transactions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

created_by   integer   

The id of an existing record in the users table. Example: 15

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 18

project_id   integer   

The id of an existing record in the projects table. Example: 16

account_id   integer   

The id of an existing record in the accounts table. Example: 17

amount   string   

Example: molestias

justification   string   

Example: iure

type   string   

Example: inflow

Must be one of:
  • inflow
  • outflow
requisition_id   integer  optional  

This field is required when type is outflow. The id of an existing record in the requisitions table. Example: 2

retirement_id   integer  optional  

This field is required when type is outflow. The id of an existing record in the retirements table. Example: 15

cost_title   string   

Example: modi

unit_price   string   

Example: rerum

quantity   integer   

Example: 5

no_of_persons   integer   

Example: 5

total   string   

Example: dolore

oca   integer  optional  

Example: 17

pca   integer  optional  

Example: 4

frequency_of_occurrence   string   

Example: quasi

Show the specified Account Transaction.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/account_transactions/amet" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/account_transactions/amet"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/account_transactions/amet';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/account_transactions/amet'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 7,
            "requisition_id": 7,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "cost_title": "development",
            "unit_price": "3000",
            "quantity": 1,
            "no_of_persons": 1,
            "total": "3000",
            "oca": null,
            "pca": null,
            "frequency_of_occurrence": "1",
            "justification": "Omnis aspernatur sun",
            "created_at": "2024-03-05T11:48:49.000000Z",
            "updated_at": "2024-03-05T11:48:49.000000Z",
            "deleted_at": null,
            "parent_id": null,
            "created_by_user": {
                "first_name": null,
                "middle_name": null,
                "last_name": null
            },
            "cost_item": null,
            "project_name": "OVC"
        },
        {
            "id": 7,
            "requisition_id": 7,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "cost_title": "development",
            "unit_price": "3000",
            "quantity": 1,
            "no_of_persons": 1,
            "total": "3000",
            "oca": null,
            "pca": null,
            "frequency_of_occurrence": "1",
            "justification": "Omnis aspernatur sun",
            "created_at": "2024-03-05T11:48:49.000000Z",
            "updated_at": "2024-03-05T11:48:49.000000Z",
            "deleted_at": null,
            "parent_id": null,
            "created_by_user": {
                "first_name": null,
                "middle_name": null,
                "last_name": null
            },
            "cost_item": null,
            "project_name": "OVC"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/account_transactions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the account transaction. Example: amet

Update the specified Account Transaction.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/account_transactions/nesciunt" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 16,
    \"organization_id\": 14,
    \"project_id\": 13,
    \"account_id\": 3,
    \"retirement_id\": 14,
    \"amount\": \"natus\",
    \"justification\": \"aut\",
    \"type\": \"inflow\",
    \"cost_items_id\": 13,
    \"requisition_id\": 13,
    \"cost_title\": \"vero\",
    \"unit_price\": \"dolore\",
    \"quantity\": 9,
    \"no_of_persons\": 20,
    \"total\": \"corporis\",
    \"oca\": 11,
    \"pca\": 5,
    \"frequency_of_occurrence\": \"et\"
}"
const url = new URL(
    "https://api.cithar.com/api/account_transactions/nesciunt"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 16,
    "organization_id": 14,
    "project_id": 13,
    "account_id": 3,
    "retirement_id": 14,
    "amount": "natus",
    "justification": "aut",
    "type": "inflow",
    "cost_items_id": 13,
    "requisition_id": 13,
    "cost_title": "vero",
    "unit_price": "dolore",
    "quantity": 9,
    "no_of_persons": 20,
    "total": "corporis",
    "oca": 11,
    "pca": 5,
    "frequency_of_occurrence": "et"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/account_transactions/nesciunt';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 16,
            'organization_id' => 14,
            'project_id' => 13,
            'account_id' => 3,
            'retirement_id' => 14,
            'amount' => 'natus',
            'justification' => 'aut',
            'type' => 'inflow',
            'cost_items_id' => 13,
            'requisition_id' => 13,
            'cost_title' => 'vero',
            'unit_price' => 'dolore',
            'quantity' => 9,
            'no_of_persons' => 20,
            'total' => 'corporis',
            'oca' => 11,
            'pca' => 5,
            'frequency_of_occurrence' => 'et',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/account_transactions/nesciunt'
payload = {
    "created_by": 16,
    "organization_id": 14,
    "project_id": 13,
    "account_id": 3,
    "retirement_id": 14,
    "amount": "natus",
    "justification": "aut",
    "type": "inflow",
    "cost_items_id": 13,
    "requisition_id": 13,
    "cost_title": "vero",
    "unit_price": "dolore",
    "quantity": 9,
    "no_of_persons": 20,
    "total": "corporis",
    "oca": 11,
    "pca": 5,
    "frequency_of_occurrence": "et"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 7,
            "requisition_id": 7,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "cost_title": "development",
            "unit_price": "3000",
            "quantity": 1,
            "no_of_persons": 1,
            "total": "3000",
            "oca": null,
            "pca": null,
            "frequency_of_occurrence": "1",
            "justification": "Omnis aspernatur sun",
            "created_at": "2024-03-05T11:48:49.000000Z",
            "updated_at": "2024-03-05T11:48:49.000000Z",
            "deleted_at": null,
            "parent_id": null,
            "created_by_user": {
                "first_name": null,
                "middle_name": null,
                "last_name": null
            },
            "cost_item": null,
            "project_name": "OVC"
        },
        {
            "id": 7,
            "requisition_id": 7,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "cost_title": "development",
            "unit_price": "3000",
            "quantity": 1,
            "no_of_persons": 1,
            "total": "3000",
            "oca": null,
            "pca": null,
            "frequency_of_occurrence": "1",
            "justification": "Omnis aspernatur sun",
            "created_at": "2024-03-05T11:48:49.000000Z",
            "updated_at": "2024-03-05T11:48:49.000000Z",
            "deleted_at": null,
            "parent_id": null,
            "created_by_user": {
                "first_name": null,
                "middle_name": null,
                "last_name": null
            },
            "cost_item": null,
            "project_name": "OVC"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

PUT api/account_transactions/{id}

PATCH api/account_transactions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the account transaction. Example: nesciunt

Body Parameters

created_by   integer  optional  

The id of an existing record in the users table. Example: 16

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 14

project_id   integer  optional  

The id of an existing record in the projects table. Example: 13

account_id   integer  optional  

The id of an existing record in the accounts table. Example: 3

retirement_id   integer  optional  

The id of an existing record in the retirements table. Example: 14

amount   string  optional  

Example: natus

justification   string  optional  

Example: aut

type   string   

Example: inflow

Must be one of:
  • inflow
  • outflow
cost_items_id   integer  optional  

The id of an existing record in the cost_items table. Example: 13

requisition_id   integer  optional  

The id of an existing record in the requisitions table. Example: 13

cost_title   string  optional  

Example: vero

unit_price   string  optional  

Example: dolore

quantity   integer  optional  

Example: 9

no_of_persons   integer  optional  

Example: 20

total   string  optional  

Example: corporis

oca   integer  optional  

Example: 11

pca   integer  optional  

Example: 5

frequency_of_occurrence   string  optional  

Example: et

Remove the specified Account Transaction.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/account_transactions/cum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/account_transactions/cum"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/account_transactions/cum';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/account_transactions/cum'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 7,
            "requisition_id": 7,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "cost_title": "development",
            "unit_price": "3000",
            "quantity": 1,
            "no_of_persons": 1,
            "total": "3000",
            "oca": null,
            "pca": null,
            "frequency_of_occurrence": "1",
            "justification": "Omnis aspernatur sun",
            "created_at": "2024-03-05T11:48:49.000000Z",
            "updated_at": "2024-03-05T11:48:49.000000Z",
            "deleted_at": null,
            "parent_id": null,
            "created_by_user": {
                "first_name": null,
                "middle_name": null,
                "last_name": null
            },
            "cost_item": null,
            "project_name": "OVC"
        },
        {
            "id": 7,
            "requisition_id": 7,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "cost_title": "development",
            "unit_price": "3000",
            "quantity": 1,
            "no_of_persons": 1,
            "total": "3000",
            "oca": null,
            "pca": null,
            "frequency_of_occurrence": "1",
            "justification": "Omnis aspernatur sun",
            "created_at": "2024-03-05T11:48:49.000000Z",
            "updated_at": "2024-03-05T11:48:49.000000Z",
            "deleted_at": null,
            "parent_id": null,
            "created_by_user": {
                "first_name": null,
                "middle_name": null,
                "last_name": null
            },
            "cost_item": null,
            "project_name": "OVC"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

DELETE api/account_transactions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the account transaction. Example: cum

Display a listing of Chart of Accounts.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/chart_of_accounts?per_page=4&type=temporibus" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/chart_of_accounts"
);

const params = {
    "per_page": "4",
    "type": "temporibus",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/chart_of_accounts';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '4',
            'type' => 'temporibus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/chart_of_accounts'
params = {
  'per_page': '4',
  'type': 'temporibus',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 5,
            "project_id": null,
            "created_by": 1,
            "type": "oca",
            "code": "333",
            "description": "Nass",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "Super",
                "middle_name": null,
                "last_name": "Admin"
            },
            "project": null,
            "project_funder": null
        },
        {
            "id": 1,
            "organization_id": 5,
            "project_id": null,
            "created_by": 1,
            "type": "oca",
            "code": "333",
            "description": "Nass",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "Super",
                "middle_name": null,
                "last_name": "Admin"
            },
            "project": null,
            "project_funder": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/chart_of_accounts

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 4

type   string  optional  

filter by pca and oca Example: temporibus

Store a newly created Chart of Accounts.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/chart_of_accounts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 2,
    \"organization_id\": 16,
    \"project_id\": 6,
    \"description\": \"Dolor consequuntur dolores velit vitae.\",
    \"code\": 6,
    \"type\": \"pca\"
}"
const url = new URL(
    "https://api.cithar.com/api/chart_of_accounts"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 2,
    "organization_id": 16,
    "project_id": 6,
    "description": "Dolor consequuntur dolores velit vitae.",
    "code": 6,
    "type": "pca"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/chart_of_accounts';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 2,
            'organization_id' => 16,
            'project_id' => 6,
            'description' => 'Dolor consequuntur dolores velit vitae.',
            'code' => 6,
            'type' => 'pca',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/chart_of_accounts'
payload = {
    "created_by": 2,
    "organization_id": 16,
    "project_id": 6,
    "description": "Dolor consequuntur dolores velit vitae.",
    "code": 6,
    "type": "pca"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 5,
            "project_id": null,
            "created_by": 1,
            "type": "oca",
            "code": "333",
            "description": "Nass",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "Super",
                "middle_name": null,
                "last_name": "Admin"
            },
            "project": null,
            "project_funder": null
        },
        {
            "id": 1,
            "organization_id": 5,
            "project_id": null,
            "created_by": 1,
            "type": "oca",
            "code": "333",
            "description": "Nass",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "Super",
                "middle_name": null,
                "last_name": "Admin"
            },
            "project": null,
            "project_funder": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

POST api/chart_of_accounts

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

created_by   integer   

The id of an existing record in the users table. Example: 2

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 16

project_id   integer  optional  

This field is required when type is pca. The id of an existing record in the projects table. Example: 6

description   string   

Example: Dolor consequuntur dolores velit vitae.

code   integer   

Example: 6

type   string   

Example: pca

Must be one of:
  • pca
  • oca

Show the specified Chart of Accounts.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/chart_of_accounts/quas" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/chart_of_accounts/quas"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/chart_of_accounts/quas';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/chart_of_accounts/quas'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 5,
            "project_id": null,
            "created_by": 1,
            "type": "oca",
            "code": "333",
            "description": "Nass",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "Super",
                "middle_name": null,
                "last_name": "Admin"
            },
            "project": null,
            "project_funder": null
        },
        {
            "id": 1,
            "organization_id": 5,
            "project_id": null,
            "created_by": 1,
            "type": "oca",
            "code": "333",
            "description": "Nass",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "Super",
                "middle_name": null,
                "last_name": "Admin"
            },
            "project": null,
            "project_funder": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/chart_of_accounts/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the chart of account. Example: quas

Update the specified Chart of Accounts.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/chart_of_accounts/est" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 12,
    \"organization_id\": 7,
    \"project_id\": 17,
    \"description\": \"Nisi inventore nobis optio distinctio nulla.\",
    \"code\": 10,
    \"type\": \"pca\"
}"
const url = new URL(
    "https://api.cithar.com/api/chart_of_accounts/est"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 12,
    "organization_id": 7,
    "project_id": 17,
    "description": "Nisi inventore nobis optio distinctio nulla.",
    "code": 10,
    "type": "pca"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/chart_of_accounts/est';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 12,
            'organization_id' => 7,
            'project_id' => 17,
            'description' => 'Nisi inventore nobis optio distinctio nulla.',
            'code' => 10,
            'type' => 'pca',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/chart_of_accounts/est'
payload = {
    "created_by": 12,
    "organization_id": 7,
    "project_id": 17,
    "description": "Nisi inventore nobis optio distinctio nulla.",
    "code": 10,
    "type": "pca"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 5,
            "project_id": null,
            "created_by": 1,
            "type": "oca",
            "code": "333",
            "description": "Nass",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "Super",
                "middle_name": null,
                "last_name": "Admin"
            },
            "project": null,
            "project_funder": null
        },
        {
            "id": 1,
            "organization_id": 5,
            "project_id": null,
            "created_by": 1,
            "type": "oca",
            "code": "333",
            "description": "Nass",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "Super",
                "middle_name": null,
                "last_name": "Admin"
            },
            "project": null,
            "project_funder": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

PUT api/chart_of_accounts/{id}

PATCH api/chart_of_accounts/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the chart of account. Example: est

Body Parameters

created_by   integer  optional  

The id of an existing record in the users table. Example: 12

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 7

project_id   integer  optional  

The id of an existing record in the projects table. Example: 17

description   string  optional  

Example: Nisi inventore nobis optio distinctio nulla.

code   integer  optional  

Example: 10

type   string  optional  

Example: pca

Must be one of:
  • pca
  • oca

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/chart_of_accounts/doloribus" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/chart_of_accounts/doloribus"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/chart_of_accounts/doloribus';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/chart_of_accounts/doloribus'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request      

DELETE api/chart_of_accounts/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the chart of account. Example: doloribus

Create a new Beneficiary details from a retirement.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/beneficiaries" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 16,
    \"organization_id\": 1,
    \"project_id\": 19,
    \"retirement_id\": 7,
    \"amount\": \"deleniti\",
    \"bank_name\": \"officiis\",
    \"account_number\": \"perspiciatis\",
    \"account_name\": \"aut\",
    \"bank_sort_code\": \"aut\",
    \"serial_number\": \"nemo\",
    \"narration\": \"doloremque\"
}"
const url = new URL(
    "https://api.cithar.com/api/beneficiaries"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 16,
    "organization_id": 1,
    "project_id": 19,
    "retirement_id": 7,
    "amount": "deleniti",
    "bank_name": "officiis",
    "account_number": "perspiciatis",
    "account_name": "aut",
    "bank_sort_code": "aut",
    "serial_number": "nemo",
    "narration": "doloremque"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/beneficiaries';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 16,
            'organization_id' => 1,
            'project_id' => 19,
            'retirement_id' => 7,
            'amount' => 'deleniti',
            'bank_name' => 'officiis',
            'account_number' => 'perspiciatis',
            'account_name' => 'aut',
            'bank_sort_code' => 'aut',
            'serial_number' => 'nemo',
            'narration' => 'doloremque',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/beneficiaries'
payload = {
    "created_by": 16,
    "organization_id": 1,
    "project_id": 19,
    "retirement_id": 7,
    "amount": "deleniti",
    "bank_name": "officiis",
    "account_number": "perspiciatis",
    "account_name": "aut",
    "bank_sort_code": "aut",
    "serial_number": "nemo",
    "narration": "doloremque"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/beneficiaries

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

created_by   integer   

The id of an existing record in the users table. Example: 16

organization_id   integer   

The id of an existing record in the organizations table. Example: 1

project_id   integer   

The id of an existing record in the projects table. Example: 19

retirement_id   integer  optional  

The id of an existing record in the retirements table. Example: 7

amount   string  optional  

Example: deleniti

bank_name   string  optional  

Example: officiis

account_number   string  optional  

Example: perspiciatis

account_name   string   

Example: aut

bank_sort_code   string  optional  

Example: aut

serial_number   string  optional  

Example: nemo

narration   string  optional  

Example: doloremque

Update the specified Cost Item.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/update_oca_pca" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"cost_item_id\": 1,
    \"oca\": \"consectetur\",
    \"pca\": \"consequatur\"
}"
const url = new URL(
    "https://api.cithar.com/api/update_oca_pca"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cost_item_id": 1,
    "oca": "consectetur",
    "pca": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/update_oca_pca';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'cost_item_id' => 1,
            'oca' => 'consectetur',
            'pca' => 'consequatur',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/update_oca_pca'
payload = {
    "cost_item_id": 1,
    "oca": "consectetur",
    "pca": "consequatur"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/update_oca_pca

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cost_item_id   integer   

The id of an existing record in the cost_items table. Example: 1

oca   string  optional  

The code of an existing record in the chart_of_account table. Example: consectetur

pca   string  optional  

The code of an existing record in the chart_of_account table. Example: consequatur

Delete a cost item from a requisition.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/requisition_cost_item" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"requisition_id\": \"facere\",
    \"type\": \"cost_item\",
    \"cost_item_id\": 16,
    \"beneficiary_detail_id\": 9
}"
const url = new URL(
    "https://api.cithar.com/api/requisition_cost_item"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "requisition_id": "facere",
    "type": "cost_item",
    "cost_item_id": 16,
    "beneficiary_detail_id": 9
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/requisition_cost_item';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'requisition_id' => 'facere',
            'type' => 'cost_item',
            'cost_item_id' => 16,
            'beneficiary_detail_id' => 9,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/requisition_cost_item'
payload = {
    "requisition_id": "facere",
    "type": "cost_item",
    "cost_item_id": 16,
    "beneficiary_detail_id": 9
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()

Request      

DELETE api/requisition_cost_item

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

requisition_id   string   

The id of an existing record in the requisitions table. Example: facere

type   string   

Example: cost_item

Must be one of:
  • cost_item
  • beneficiary
cost_item_id   integer  optional  

This field is required when type is cost_item. The id of an existing record in the cost_items table. Example: 16

beneficiary_detail_id   integer  optional  

This field is required when type is beneficiary. The id of an existing record in the beneficiaries_detail table. Example: 9

Delete a beneficiary detail from a requisition.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/requisition_beneficiary" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"requisition_id\": \"tenetur\",
    \"type\": \"beneficiary\",
    \"cost_item_id\": 7,
    \"beneficiary_detail_id\": 1
}"
const url = new URL(
    "https://api.cithar.com/api/requisition_beneficiary"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "requisition_id": "tenetur",
    "type": "beneficiary",
    "cost_item_id": 7,
    "beneficiary_detail_id": 1
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/requisition_beneficiary';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'requisition_id' => 'tenetur',
            'type' => 'beneficiary',
            'cost_item_id' => 7,
            'beneficiary_detail_id' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/requisition_beneficiary'
payload = {
    "requisition_id": "tenetur",
    "type": "beneficiary",
    "cost_item_id": 7,
    "beneficiary_detail_id": 1
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()

Request      

DELETE api/requisition_beneficiary

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

requisition_id   string   

The id of an existing record in the requisitions table. Example: tenetur

type   string   

Example: beneficiary

Must be one of:
  • cost_item
  • beneficiary
cost_item_id   integer  optional  

This field is required when type is cost_item. The id of an existing record in the cost_items table. Example: 7

beneficiary_detail_id   integer  optional  

This field is required when type is beneficiary. The id of an existing record in the beneficiaries_detail table. Example: 1

Holiday Endpoints

Display a listing of Holidays.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/holidays?term=molestias&per_page=3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/holidays"
);

const params = {
    "term": "molestias",
    "per_page": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/holidays';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'term' => 'molestias',
            'per_page' => '3',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/holidays'
params = {
  'term': 'molestias',
  'per_page': '3',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "type": "private",
            "description": "gyhfgvhghgyfhgj",
            "organization_id": 12,
            "start_date": "2024-03-07",
            "end_date": "2024-03-08",
            "created_at": "2024-03-05T11:53:35.000000Z",
            "updated_at": "2024-03-05T11:53:53.000000Z",
            "deleted_at": null
        },
        {
            "id": 1,
            "type": "private",
            "description": "gyhfgvhghgyfhgj",
            "organization_id": 12,
            "start_date": "2024-03-07",
            "end_date": "2024-03-08",
            "created_at": "2024-03-05T11:53:35.000000Z",
            "updated_at": "2024-03-05T11:53:53.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/holidays

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

term   string  optional  

Search query parameter for string data type, like; description, and lev type Example: molestias

per_page   integer  optional  

Items per page Example: 3

Store a newly created Holiday.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/holidays" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"nisi\",
    \"description\": \"Est harum molestiae repudiandae voluptas quia.\",
    \"organization_id\": 15,
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2026-01-25T16:32:31\"
}"
const url = new URL(
    "https://api.cithar.com/api/holidays"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "nisi",
    "description": "Est harum molestiae repudiandae voluptas quia.",
    "organization_id": 15,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/holidays';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'nisi',
            'description' => 'Est harum molestiae repudiandae voluptas quia.',
            'organization_id' => 15,
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2026-01-25T16:32:31',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/holidays'
payload = {
    "type": "nisi",
    "description": "Est harum molestiae repudiandae voluptas quia.",
    "organization_id": 15,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "type": "private",
            "description": "gyhfgvhghgyfhgj",
            "organization_id": 12,
            "start_date": "2024-03-07",
            "end_date": "2024-03-08",
            "created_at": "2024-03-05T11:53:35.000000Z",
            "updated_at": "2024-03-05T11:53:53.000000Z",
            "deleted_at": null
        },
        {
            "id": 1,
            "type": "private",
            "description": "gyhfgvhghgyfhgj",
            "organization_id": 12,
            "start_date": "2024-03-07",
            "end_date": "2024-03-08",
            "created_at": "2024-03-05T11:53:35.000000Z",
            "updated_at": "2024-03-05T11:53:53.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

POST api/holidays

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

type   string   

Example: nisi

description   string  optional  

Example: Est harum molestiae repudiandae voluptas quia.

organization_id   integer   

The id of an existing record in the organizations table. Example: 15

start_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

Display the specified Holiday.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/holidays/9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/holidays/9"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/holidays/9';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/holidays/9'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "type": "private",
            "description": "gyhfgvhghgyfhgj",
            "organization_id": 12,
            "start_date": "2024-03-07",
            "end_date": "2024-03-08",
            "created_at": "2024-03-05T11:53:35.000000Z",
            "updated_at": "2024-03-05T11:53:53.000000Z",
            "deleted_at": null
        },
        {
            "id": 1,
            "type": "private",
            "description": "gyhfgvhghgyfhgj",
            "organization_id": 12,
            "start_date": "2024-03-07",
            "end_date": "2024-03-08",
            "created_at": "2024-03-05T11:53:35.000000Z",
            "updated_at": "2024-03-05T11:53:53.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/holidays/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Holiday Example: 9

Update the specified Holiday.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/holidays/12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"nihil\",
    \"description\": \"Id aut corporis voluptas qui vel.\",
    \"organization_id\": 20,
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2026-01-25T16:32:31\"
}"
const url = new URL(
    "https://api.cithar.com/api/holidays/12"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "nihil",
    "description": "Id aut corporis voluptas qui vel.",
    "organization_id": 20,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/holidays/12';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'nihil',
            'description' => 'Id aut corporis voluptas qui vel.',
            'organization_id' => 20,
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2026-01-25T16:32:31',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/holidays/12'
payload = {
    "type": "nihil",
    "description": "Id aut corporis voluptas qui vel.",
    "organization_id": 20,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "type": "private",
            "description": "gyhfgvhghgyfhgj",
            "organization_id": 12,
            "start_date": "2024-03-07",
            "end_date": "2024-03-08",
            "created_at": "2024-03-05T11:53:35.000000Z",
            "updated_at": "2024-03-05T11:53:53.000000Z",
            "deleted_at": null
        },
        {
            "id": 1,
            "type": "private",
            "description": "gyhfgvhghgyfhgj",
            "organization_id": 12,
            "start_date": "2024-03-07",
            "end_date": "2024-03-08",
            "created_at": "2024-03-05T11:53:35.000000Z",
            "updated_at": "2024-03-05T11:53:53.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

PUT api/holidays/{id}

PATCH api/holidays/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Holiday Example: 12

Body Parameters

type   string  optional  

Example: nihil

description   string  optional  

Example: Id aut corporis voluptas qui vel.

organization_id   integer   

The id of an existing record in the organizations table. Example: 20

start_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

Remove the specified Holiday.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/holidays/13" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/holidays/13"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/holidays/13';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/holidays/13'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request      

DELETE api/holidays/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Holiday Example: 13

Leave Endpoints

Display a listing of the Assets.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/leaves?term=saepe&per_page=15&created_by=4&start_date=sequi&end_date=vero" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/leaves"
);

const params = {
    "term": "saepe",
    "per_page": "15",
    "created_by": "4",
    "start_date": "sequi",
    "end_date": "vero",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/leaves';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'term' => 'saepe',
            'per_page' => '15',
            'created_by' => '4',
            'start_date' => 'sequi',
            'end_date' => 'vero',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/leaves'
params = {
  'term': 'saepe',
  'per_page': '15',
  'created_by': '4',
  'start_date': 'sequi',
  'end_date': 'vero',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "user_id": 3,
            "organization_id": 12,
            "start_date": "2024-03-06",
            "end_date": "2024-03-10",
            "type": "sick",
            "reason": "gffvhbjm",
            "number_of_days": "4",
            "created_at": "2024-03-05T11:19:02.000000Z",
            "updated_at": "2024-03-05T11:19:02.000000Z",
            "deleted_at": null,
            "user": {
                "id": 3,
                "email": "ernestshedrach@gmail.com"
            },
            "user_details": {
                "first_name": "purityriordesign",
                "middle_name": null,
                "last_name": null
            },
            "approval_details": {
                "total_required_approvers": 2,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "hr level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "fgfgjbhgbn",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:22:36.399105Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        },
        {
            "id": 1,
            "user_id": 3,
            "organization_id": 12,
            "start_date": "2024-03-06",
            "end_date": "2024-03-10",
            "type": "sick",
            "reason": "gffvhbjm",
            "number_of_days": "4",
            "created_at": "2024-03-05T11:19:02.000000Z",
            "updated_at": "2024-03-05T11:19:02.000000Z",
            "deleted_at": null,
            "user": {
                "id": 3,
                "email": "ernestshedrach@gmail.com"
            },
            "user_details": {
                "first_name": "purityriordesign",
                "middle_name": null,
                "last_name": null
            },
            "approval_details": {
                "total_required_approvers": 2,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "hr level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "fgfgjbhgbn",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:22:36.399105Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/leaves

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

term   string  optional  

Search query parameter for string data type Example: saepe

per_page   integer  optional  

Items per page Example: 15

created_by   integer  optional  

get a specific user leaves Example: 4

start_date   string  optional  

datetime filter by a date range Example: sequi

end_date   string  optional  

datetime filter by a date range Example: vero

Store a new created Leave

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/leaves" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 8,
    \"approver\": 9,
    \"approver_role\": \"est\",
    \"organization_id\": 15,
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2026-01-25T16:32:31\",
    \"type\": \"voluptatem\",
    \"reason\": \"quidem\",
    \"number_of_days\": 1
}"
const url = new URL(
    "https://api.cithar.com/api/leaves"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 8,
    "approver": 9,
    "approver_role": "est",
    "organization_id": 15,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31",
    "type": "voluptatem",
    "reason": "quidem",
    "number_of_days": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/leaves';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'user_id' => 8,
            'approver' => 9,
            'approver_role' => 'est',
            'organization_id' => 15,
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2026-01-25T16:32:31',
            'type' => 'voluptatem',
            'reason' => 'quidem',
            'number_of_days' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/leaves'
payload = {
    "user_id": 8,
    "approver": 9,
    "approver_role": "est",
    "organization_id": 15,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31",
    "type": "voluptatem",
    "reason": "quidem",
    "number_of_days": 1
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "user_id": 3,
            "organization_id": 12,
            "start_date": "2024-03-06",
            "end_date": "2024-03-10",
            "type": "sick",
            "reason": "gffvhbjm",
            "number_of_days": "4",
            "created_at": "2024-03-05T11:19:02.000000Z",
            "updated_at": "2024-03-05T11:19:02.000000Z",
            "deleted_at": null,
            "user": {
                "id": 3,
                "email": "ernestshedrach@gmail.com"
            },
            "user_details": {
                "first_name": "purityriordesign",
                "middle_name": null,
                "last_name": null
            },
            "approval_details": {
                "total_required_approvers": 2,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "hr level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "fgfgjbhgbn",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:22:36.399105Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        },
        {
            "id": 1,
            "user_id": 3,
            "organization_id": 12,
            "start_date": "2024-03-06",
            "end_date": "2024-03-10",
            "type": "sick",
            "reason": "gffvhbjm",
            "number_of_days": "4",
            "created_at": "2024-03-05T11:19:02.000000Z",
            "updated_at": "2024-03-05T11:19:02.000000Z",
            "deleted_at": null,
            "user": {
                "id": 3,
                "email": "ernestshedrach@gmail.com"
            },
            "user_details": {
                "first_name": "purityriordesign",
                "middle_name": null,
                "last_name": null
            },
            "approval_details": {
                "total_required_approvers": 2,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "hr level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "fgfgjbhgbn",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:22:36.399105Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        }
    ]
}
 

Request      

POST api/leaves

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_id   integer   

The id of an existing record in the users table. Example: 8

approver   integer   

The id of an existing record in the users table. Example: 9

approver_role   string   

The name of an existing record in the roles table. Example: est

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 15

start_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

type   string   

Example: voluptatem

reason   string   

Example: quidem

number_of_days   integer  optional  

Example: 1

Show a specified Leave.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/leaves/19" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/leaves/19"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/leaves/19';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/leaves/19'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "user_id": 3,
            "organization_id": 12,
            "start_date": "2024-03-06",
            "end_date": "2024-03-10",
            "type": "sick",
            "reason": "gffvhbjm",
            "number_of_days": "4",
            "created_at": "2024-03-05T11:19:02.000000Z",
            "updated_at": "2024-03-05T11:19:02.000000Z",
            "deleted_at": null,
            "user": {
                "id": 3,
                "email": "ernestshedrach@gmail.com"
            },
            "user_details": {
                "first_name": "purityriordesign",
                "middle_name": null,
                "last_name": null
            },
            "approval_details": {
                "total_required_approvers": 2,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "hr level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "fgfgjbhgbn",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:22:36.399105Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        },
        {
            "id": 1,
            "user_id": 3,
            "organization_id": 12,
            "start_date": "2024-03-06",
            "end_date": "2024-03-10",
            "type": "sick",
            "reason": "gffvhbjm",
            "number_of_days": "4",
            "created_at": "2024-03-05T11:19:02.000000Z",
            "updated_at": "2024-03-05T11:19:02.000000Z",
            "deleted_at": null,
            "user": {
                "id": 3,
                "email": "ernestshedrach@gmail.com"
            },
            "user_details": {
                "first_name": "purityriordesign",
                "middle_name": null,
                "last_name": null
            },
            "approval_details": {
                "total_required_approvers": 2,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "hr level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "fgfgjbhgbn",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:22:36.399105Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        }
    ]
}
 

Request      

GET api/leaves/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Leave Example: 19

Update the specified Leave.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/leaves/13" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 19,
    \"approver\": 13,
    \"approver_role\": \"assumenda\",
    \"organization_id\": 12,
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2026-01-25T16:32:31\",
    \"type\": \"modi\",
    \"reason\": \"repellendus\"
}"
const url = new URL(
    "https://api.cithar.com/api/leaves/13"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 19,
    "approver": 13,
    "approver_role": "assumenda",
    "organization_id": 12,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31",
    "type": "modi",
    "reason": "repellendus"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/leaves/13';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'user_id' => 19,
            'approver' => 13,
            'approver_role' => 'assumenda',
            'organization_id' => 12,
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2026-01-25T16:32:31',
            'type' => 'modi',
            'reason' => 'repellendus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/leaves/13'
payload = {
    "user_id": 19,
    "approver": 13,
    "approver_role": "assumenda",
    "organization_id": 12,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31",
    "type": "modi",
    "reason": "repellendus"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "user_id": 3,
            "organization_id": 12,
            "start_date": "2024-03-06",
            "end_date": "2024-03-10",
            "type": "sick",
            "reason": "gffvhbjm",
            "number_of_days": "4",
            "created_at": "2024-03-05T11:19:02.000000Z",
            "updated_at": "2024-03-05T11:19:02.000000Z",
            "deleted_at": null,
            "user": {
                "id": 3,
                "email": "ernestshedrach@gmail.com"
            },
            "user_details": {
                "first_name": "purityriordesign",
                "middle_name": null,
                "last_name": null
            },
            "approval_details": {
                "total_required_approvers": 2,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "hr level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "fgfgjbhgbn",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:22:36.399105Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        },
        {
            "id": 1,
            "user_id": 3,
            "organization_id": 12,
            "start_date": "2024-03-06",
            "end_date": "2024-03-10",
            "type": "sick",
            "reason": "gffvhbjm",
            "number_of_days": "4",
            "created_at": "2024-03-05T11:19:02.000000Z",
            "updated_at": "2024-03-05T11:19:02.000000Z",
            "deleted_at": null,
            "user": {
                "id": 3,
                "email": "ernestshedrach@gmail.com"
            },
            "user_details": {
                "first_name": "purityriordesign",
                "middle_name": null,
                "last_name": null
            },
            "approval_details": {
                "total_required_approvers": 2,
                "status": "pending",
                "current_approver": 4,
                "current_approver_role": "hr level 1",
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "fgfgjbhgbn",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:22:36.399105Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "rejected_details": null
            }
        }
    ]
}
 

Request      

PUT api/leaves/{id}

PATCH api/leaves/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Leave Example: 13

Body Parameters

user_id   integer  optional  

The id of an existing record in the users table. Example: 19

approver   integer  optional  

The id of an existing record in the users table. Example: 13

approver_role   string  optional  

The name of an existing record in the roles table. Example: assumenda

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 12

start_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

type   string  optional  

Example: modi

reason   string  optional  

Example: repellendus

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/leave_report" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/leave_report"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/leave_report';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/leave_report'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/leave_report could not be found."
}
 

Request      

GET api/leave_report

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/leave_report" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 4,
    \"user_id\": 4,
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2026-01-25T16:32:31\",
    \"type\": \"ut\"
}"
const url = new URL(
    "https://api.cithar.com/api/leave_report"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 4,
    "user_id": 4,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31",
    "type": "ut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/leave_report';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'organization_id' => 4,
            'user_id' => 4,
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2026-01-25T16:32:31',
            'type' => 'ut',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/leave_report'
payload = {
    "organization_id": 4,
    "user_id": 4,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31",
    "type": "ut"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/leave_report

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

organization_id   integer   

The id of an existing record in the organizations table. Example: 4

user_id   integer   

The id of an existing record in the users table. Example: 4

start_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

type   string  optional  

Example: ut

Show the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/leave_report/sunt" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/leave_report/sunt"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/leave_report/sunt';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/leave_report/sunt'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/leave_report/sunt could not be found."
}
 

Request      

GET api/leave_report/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the leave report. Example: sunt

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/leave_report/aut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/leave_report/aut"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/leave_report/aut';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/leave_report/aut'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request      

PUT api/leave_report/{id}

PATCH api/leave_report/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the leave report. Example: aut

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/leave_report/repellat" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/leave_report/repellat"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/leave_report/repellat';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/leave_report/repellat'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request      

DELETE api/leave_report/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the leave report. Example: repellat

Get a logged-in user list of Leaves.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_user_leaves" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/get_user_leaves"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_user_leaves';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_user_leaves'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_user_leaves could not be found."
}
 

Request      

GET api/get_user_leaves

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Organization Endpoints

Display a listing of the Organizations.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/organizations?term=qui&per_page=7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/organizations"
);

const params = {
    "term": "qui",
    "per_page": "7",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/organizations';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'term' => 'qui',
            'per_page' => '7',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/organizations'
params = {
  'term': 'qui',
  'per_page': '7',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 5,
            "name": "Test organization",
            "email": "testorganization@cithar.com",
            "phone_number": "09053003200",
            "registration_number": "0099890098",
            "country": "Nigeria",
            "state": "Enugu",
            "city": "Independence Layout",
            "postcode": "40001",
            "address": "28 avenue street",
            "sector": null,
            "website": "https://www.cithar.com",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "subscription_plan": {
                "id": 1,
                "organization_id": 5,
                "payment_reference": null,
                "start_date": "2024-03-03",
                "end_date": "2024-04-03",
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "app_configuration": {
                "id": 1,
                "organization_id": 5,
                "organization_color": "green",
                "organization_logo": null,
                "thematic_areas": [
                    "No Poverty",
                    "Gender Equality",
                    "Quality Education"
                ],
                "noa_requisition": 2,
                "noa_requisition_names": [
                    "admin level 2",
                    "admin level 1"
                ],
                "noa_retirement": 2,
                "noa_retirement_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_timesheet": 2,
                "noa_timesheet_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_leave": 2,
                "noa_leave_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "payment_voucher_number": 4444,
                "financial_year_start_month": 1,
                "financial_year_end_month": 1,
                "month_start_day": 1,
                "month_end_day": 31,
                "last_payment_voucher_number": null,
                "hr_year_start_month": 1,
                "hr_year_end_month": 1,
                "leave_type_setup": [
                    "sick: 2",
                    "bereavement: 2",
                    "unpaid: 2",
                    "study: 2",
                    "vacation: 2",
                    "compassionate: 2",
                    "maternity: 2",
                    "paternity: 2",
                    "junior_staff: 2",
                    "senior_staff: 2"
                ],
                "work_hour_per_day": [
                    "monday: 8",
                    "tuesday: 8",
                    "wednesday: 8",
                    "thursday: 8",
                    "friday: 8",
                    "saturday: 8",
                    "sunday: 8"
                ],
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "chart_of_account": [
                {
                    "id": 1,
                    "organization_id": 5,
                    "project_id": null,
                    "created_by": 1,
                    "type": "oca",
                    "code": "333",
                    "description": "Nass",
                    "created_at": "2024-03-03T21:46:10.000000Z",
                    "updated_at": "2024-03-03T21:46:10.000000Z",
                    "deleted_at": null
                }
            ]
        },
        {
            "id": 5,
            "name": "Test organization",
            "email": "testorganization@cithar.com",
            "phone_number": "09053003200",
            "registration_number": "0099890098",
            "country": "Nigeria",
            "state": "Enugu",
            "city": "Independence Layout",
            "postcode": "40001",
            "address": "28 avenue street",
            "sector": null,
            "website": "https://www.cithar.com",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "subscription_plan": {
                "id": 1,
                "organization_id": 5,
                "payment_reference": null,
                "start_date": "2024-03-03",
                "end_date": "2024-04-03",
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "app_configuration": {
                "id": 1,
                "organization_id": 5,
                "organization_color": "green",
                "organization_logo": null,
                "thematic_areas": [
                    "No Poverty",
                    "Gender Equality",
                    "Quality Education"
                ],
                "noa_requisition": 2,
                "noa_requisition_names": [
                    "admin level 2",
                    "admin level 1"
                ],
                "noa_retirement": 2,
                "noa_retirement_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_timesheet": 2,
                "noa_timesheet_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_leave": 2,
                "noa_leave_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "payment_voucher_number": 4444,
                "financial_year_start_month": 1,
                "financial_year_end_month": 1,
                "month_start_day": 1,
                "month_end_day": 31,
                "last_payment_voucher_number": null,
                "hr_year_start_month": 1,
                "hr_year_end_month": 1,
                "leave_type_setup": [
                    "sick: 2",
                    "bereavement: 2",
                    "unpaid: 2",
                    "study: 2",
                    "vacation: 2",
                    "compassionate: 2",
                    "maternity: 2",
                    "paternity: 2",
                    "junior_staff: 2",
                    "senior_staff: 2"
                ],
                "work_hour_per_day": [
                    "monday: 8",
                    "tuesday: 8",
                    "wednesday: 8",
                    "thursday: 8",
                    "friday: 8",
                    "saturday: 8",
                    "sunday: 8"
                ],
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "chart_of_account": [
                {
                    "id": 1,
                    "organization_id": 5,
                    "project_id": null,
                    "created_by": 1,
                    "type": "oca",
                    "code": "333",
                    "description": "Nass",
                    "created_at": "2024-03-03T21:46:10.000000Z",
                    "updated_at": "2024-03-03T21:46:10.000000Z",
                    "deleted_at": null
                }
            ]
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/organizations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

term   string  optional  

Search query parameter for string data type, like: email, phone number, registration umber Example: qui

per_page   integer  optional  

Items per page Example: 7

Store a newly created Organization.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/organizations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"dolorem\",
    \"email\": \"charlie.hauck@example.com\",
    \"phone_number\": \"ullam\",
    \"registration_number\": \"architecto\",
    \"country\": \"et\",
    \"state\": \"temporibus\",
    \"city\": \"aut\",
    \"postcode\": \"officia\",
    \"address\": \"aperiam\",
    \"website\": \"http:\\/\\/www.lueilwitz.com\\/est-sequi-fuga-est-quia-aliquam\",
    \"thematic_areas\": [
        \"aut\"
    ],
    \"organization_color\": \"sunt\",
    \"organization_logo\": \"vel\",
    \"noa_requisition\": 3,
    \"noa_requisition_names\": [
        \"provident\"
    ],
    \"noa_retirement\": 16,
    \"noa_retirement_names\": [
        \"possimus\"
    ],
    \"noa_leave\": 5,
    \"noa_leave_names\": [
        \"rerum\"
    ],
    \"noa_timesheet\": 13,
    \"noa_timesheet_names\": [
        \"est\"
    ],
    \"financial_year_start_month\": 5,
    \"financial_year_end_month\": 17,
    \"payment_voucher_number\": 9,
    \"month_start_day\": 20,
    \"month_end_day\": 11,
    \"hr_year_start_month\": 1,
    \"hr_year_end_month\": 1,
    \"account_codes\": [
        {
            \"code\": 2,
            \"description\": \"Hic unde voluptas sunt aut atque fugit quo et.\"
        }
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/organizations"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "dolorem",
    "email": "charlie.hauck@example.com",
    "phone_number": "ullam",
    "registration_number": "architecto",
    "country": "et",
    "state": "temporibus",
    "city": "aut",
    "postcode": "officia",
    "address": "aperiam",
    "website": "http:\/\/www.lueilwitz.com\/est-sequi-fuga-est-quia-aliquam",
    "thematic_areas": [
        "aut"
    ],
    "organization_color": "sunt",
    "organization_logo": "vel",
    "noa_requisition": 3,
    "noa_requisition_names": [
        "provident"
    ],
    "noa_retirement": 16,
    "noa_retirement_names": [
        "possimus"
    ],
    "noa_leave": 5,
    "noa_leave_names": [
        "rerum"
    ],
    "noa_timesheet": 13,
    "noa_timesheet_names": [
        "est"
    ],
    "financial_year_start_month": 5,
    "financial_year_end_month": 17,
    "payment_voucher_number": 9,
    "month_start_day": 20,
    "month_end_day": 11,
    "hr_year_start_month": 1,
    "hr_year_end_month": 1,
    "account_codes": [
        {
            "code": 2,
            "description": "Hic unde voluptas sunt aut atque fugit quo et."
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/organizations';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'dolorem',
            'email' => 'charlie.hauck@example.com',
            'phone_number' => 'ullam',
            'registration_number' => 'architecto',
            'country' => 'et',
            'state' => 'temporibus',
            'city' => 'aut',
            'postcode' => 'officia',
            'address' => 'aperiam',
            'website' => 'http://www.lueilwitz.com/est-sequi-fuga-est-quia-aliquam',
            'thematic_areas' => [
                'aut',
            ],
            'organization_color' => 'sunt',
            'organization_logo' => 'vel',
            'noa_requisition' => 3,
            'noa_requisition_names' => [
                'provident',
            ],
            'noa_retirement' => 16,
            'noa_retirement_names' => [
                'possimus',
            ],
            'noa_leave' => 5,
            'noa_leave_names' => [
                'rerum',
            ],
            'noa_timesheet' => 13,
            'noa_timesheet_names' => [
                'est',
            ],
            'financial_year_start_month' => 5,
            'financial_year_end_month' => 17,
            'payment_voucher_number' => 9,
            'month_start_day' => 20,
            'month_end_day' => 11,
            'hr_year_start_month' => 1,
            'hr_year_end_month' => 1,
            'account_codes' => [
                [
                    'code' => 2,
                    'description' => 'Hic unde voluptas sunt aut atque fugit quo et.',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/organizations'
payload = {
    "name": "dolorem",
    "email": "charlie.hauck@example.com",
    "phone_number": "ullam",
    "registration_number": "architecto",
    "country": "et",
    "state": "temporibus",
    "city": "aut",
    "postcode": "officia",
    "address": "aperiam",
    "website": "http:\/\/www.lueilwitz.com\/est-sequi-fuga-est-quia-aliquam",
    "thematic_areas": [
        "aut"
    ],
    "organization_color": "sunt",
    "organization_logo": "vel",
    "noa_requisition": 3,
    "noa_requisition_names": [
        "provident"
    ],
    "noa_retirement": 16,
    "noa_retirement_names": [
        "possimus"
    ],
    "noa_leave": 5,
    "noa_leave_names": [
        "rerum"
    ],
    "noa_timesheet": 13,
    "noa_timesheet_names": [
        "est"
    ],
    "financial_year_start_month": 5,
    "financial_year_end_month": 17,
    "payment_voucher_number": 9,
    "month_start_day": 20,
    "month_end_day": 11,
    "hr_year_start_month": 1,
    "hr_year_end_month": 1,
    "account_codes": [
        {
            "code": 2,
            "description": "Hic unde voluptas sunt aut atque fugit quo et."
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 5,
            "name": "Test organization",
            "email": "testorganization@cithar.com",
            "phone_number": "09053003200",
            "registration_number": "0099890098",
            "country": "Nigeria",
            "state": "Enugu",
            "city": "Independence Layout",
            "postcode": "40001",
            "address": "28 avenue street",
            "sector": null,
            "website": "https://www.cithar.com",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "subscription_plan": {
                "id": 1,
                "organization_id": 5,
                "payment_reference": null,
                "start_date": "2024-03-03",
                "end_date": "2024-04-03",
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "app_configuration": {
                "id": 1,
                "organization_id": 5,
                "organization_color": "green",
                "organization_logo": null,
                "thematic_areas": [
                    "No Poverty",
                    "Gender Equality",
                    "Quality Education"
                ],
                "noa_requisition": 2,
                "noa_requisition_names": [
                    "admin level 2",
                    "admin level 1"
                ],
                "noa_retirement": 2,
                "noa_retirement_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_timesheet": 2,
                "noa_timesheet_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_leave": 2,
                "noa_leave_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "payment_voucher_number": 4444,
                "financial_year_start_month": 1,
                "financial_year_end_month": 1,
                "month_start_day": 1,
                "month_end_day": 31,
                "last_payment_voucher_number": null,
                "hr_year_start_month": 1,
                "hr_year_end_month": 1,
                "leave_type_setup": [
                    "sick: 2",
                    "bereavement: 2",
                    "unpaid: 2",
                    "study: 2",
                    "vacation: 2",
                    "compassionate: 2",
                    "maternity: 2",
                    "paternity: 2",
                    "junior_staff: 2",
                    "senior_staff: 2"
                ],
                "work_hour_per_day": [
                    "monday: 8",
                    "tuesday: 8",
                    "wednesday: 8",
                    "thursday: 8",
                    "friday: 8",
                    "saturday: 8",
                    "sunday: 8"
                ],
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "chart_of_account": [
                {
                    "id": 1,
                    "organization_id": 5,
                    "project_id": null,
                    "created_by": 1,
                    "type": "oca",
                    "code": "333",
                    "description": "Nass",
                    "created_at": "2024-03-03T21:46:10.000000Z",
                    "updated_at": "2024-03-03T21:46:10.000000Z",
                    "deleted_at": null
                }
            ]
        },
        {
            "id": 5,
            "name": "Test organization",
            "email": "testorganization@cithar.com",
            "phone_number": "09053003200",
            "registration_number": "0099890098",
            "country": "Nigeria",
            "state": "Enugu",
            "city": "Independence Layout",
            "postcode": "40001",
            "address": "28 avenue street",
            "sector": null,
            "website": "https://www.cithar.com",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "subscription_plan": {
                "id": 1,
                "organization_id": 5,
                "payment_reference": null,
                "start_date": "2024-03-03",
                "end_date": "2024-04-03",
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "app_configuration": {
                "id": 1,
                "organization_id": 5,
                "organization_color": "green",
                "organization_logo": null,
                "thematic_areas": [
                    "No Poverty",
                    "Gender Equality",
                    "Quality Education"
                ],
                "noa_requisition": 2,
                "noa_requisition_names": [
                    "admin level 2",
                    "admin level 1"
                ],
                "noa_retirement": 2,
                "noa_retirement_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_timesheet": 2,
                "noa_timesheet_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_leave": 2,
                "noa_leave_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "payment_voucher_number": 4444,
                "financial_year_start_month": 1,
                "financial_year_end_month": 1,
                "month_start_day": 1,
                "month_end_day": 31,
                "last_payment_voucher_number": null,
                "hr_year_start_month": 1,
                "hr_year_end_month": 1,
                "leave_type_setup": [
                    "sick: 2",
                    "bereavement: 2",
                    "unpaid: 2",
                    "study: 2",
                    "vacation: 2",
                    "compassionate: 2",
                    "maternity: 2",
                    "paternity: 2",
                    "junior_staff: 2",
                    "senior_staff: 2"
                ],
                "work_hour_per_day": [
                    "monday: 8",
                    "tuesday: 8",
                    "wednesday: 8",
                    "thursday: 8",
                    "friday: 8",
                    "saturday: 8",
                    "sunday: 8"
                ],
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "chart_of_account": [
                {
                    "id": 1,
                    "organization_id": 5,
                    "project_id": null,
                    "created_by": 1,
                    "type": "oca",
                    "code": "333",
                    "description": "Nass",
                    "created_at": "2024-03-03T21:46:10.000000Z",
                    "updated_at": "2024-03-03T21:46:10.000000Z",
                    "deleted_at": null
                }
            ]
        }
    ]
}
 

Request      

POST api/organizations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: dolorem

email   string   

Must be a valid email address. Example: charlie.hauck@example.com

phone_number   string   

Example: ullam

registration_number   string   

Example: architecto

country   string   

Example: et

state   string   

Example: temporibus

city   string   

Example: aut

postcode   string  optional  

Example: officia

address   string   

Example: aperiam

website   string   

Must be a valid URL. Example: http://www.lueilwitz.com/est-sequi-fuga-est-quia-aliquam

thematic_areas   string[]  optional  
account_codes   object[]  optional  
code   integer  optional  

This field is required when account_codes is present. Example: 2

description   string  optional  

This field is required when account_codes is present. Example: Hic unde voluptas sunt aut atque fugit quo et.

organization_color   string  optional  

Example: sunt

organization_logo   string  optional  

Example: vel

noa_requisition   integer   

Example: 3

noa_requisition_names   string[]  optional  

The name of an existing record in the roles table.

noa_retirement   integer   

Example: 16

noa_retirement_names   string[]  optional  

The name of an existing record in the roles table.

noa_leave   integer   

Example: 5

noa_leave_names   string[]  optional  

The name of an existing record in the roles table.

noa_timesheet   integer   

Example: 13

noa_timesheet_names   string[]  optional  

The name of an existing record in the roles table.

financial_year_start_month   integer  optional  

Example: 5

financial_year_end_month   integer  optional  

Example: 17

payment_voucher_number   integer   

Example: 9

month_start_day   integer   

Example: 20

month_end_day   integer   

Example: 11

hr_year_start_month   integer  optional  

Example: 1

hr_year_end_month   integer  optional  

Example: 1

leave_type_setup   object  optional  
work_hour_per_day   object  optional  

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/organizations/18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/organizations/18"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/organizations/18';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/organizations/18'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 5,
            "name": "Test organization",
            "email": "testorganization@cithar.com",
            "phone_number": "09053003200",
            "registration_number": "0099890098",
            "country": "Nigeria",
            "state": "Enugu",
            "city": "Independence Layout",
            "postcode": "40001",
            "address": "28 avenue street",
            "sector": null,
            "website": "https://www.cithar.com",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "subscription_plan": {
                "id": 1,
                "organization_id": 5,
                "payment_reference": null,
                "start_date": "2024-03-03",
                "end_date": "2024-04-03",
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "app_configuration": {
                "id": 1,
                "organization_id": 5,
                "organization_color": "green",
                "organization_logo": null,
                "thematic_areas": [
                    "No Poverty",
                    "Gender Equality",
                    "Quality Education"
                ],
                "noa_requisition": 2,
                "noa_requisition_names": [
                    "admin level 2",
                    "admin level 1"
                ],
                "noa_retirement": 2,
                "noa_retirement_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_timesheet": 2,
                "noa_timesheet_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_leave": 2,
                "noa_leave_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "payment_voucher_number": 4444,
                "financial_year_start_month": 1,
                "financial_year_end_month": 1,
                "month_start_day": 1,
                "month_end_day": 31,
                "last_payment_voucher_number": null,
                "hr_year_start_month": 1,
                "hr_year_end_month": 1,
                "leave_type_setup": [
                    "sick: 2",
                    "bereavement: 2",
                    "unpaid: 2",
                    "study: 2",
                    "vacation: 2",
                    "compassionate: 2",
                    "maternity: 2",
                    "paternity: 2",
                    "junior_staff: 2",
                    "senior_staff: 2"
                ],
                "work_hour_per_day": [
                    "monday: 8",
                    "tuesday: 8",
                    "wednesday: 8",
                    "thursday: 8",
                    "friday: 8",
                    "saturday: 8",
                    "sunday: 8"
                ],
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "chart_of_account": [
                {
                    "id": 1,
                    "organization_id": 5,
                    "project_id": null,
                    "created_by": 1,
                    "type": "oca",
                    "code": "333",
                    "description": "Nass",
                    "created_at": "2024-03-03T21:46:10.000000Z",
                    "updated_at": "2024-03-03T21:46:10.000000Z",
                    "deleted_at": null
                }
            ]
        },
        {
            "id": 5,
            "name": "Test organization",
            "email": "testorganization@cithar.com",
            "phone_number": "09053003200",
            "registration_number": "0099890098",
            "country": "Nigeria",
            "state": "Enugu",
            "city": "Independence Layout",
            "postcode": "40001",
            "address": "28 avenue street",
            "sector": null,
            "website": "https://www.cithar.com",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "subscription_plan": {
                "id": 1,
                "organization_id": 5,
                "payment_reference": null,
                "start_date": "2024-03-03",
                "end_date": "2024-04-03",
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "app_configuration": {
                "id": 1,
                "organization_id": 5,
                "organization_color": "green",
                "organization_logo": null,
                "thematic_areas": [
                    "No Poverty",
                    "Gender Equality",
                    "Quality Education"
                ],
                "noa_requisition": 2,
                "noa_requisition_names": [
                    "admin level 2",
                    "admin level 1"
                ],
                "noa_retirement": 2,
                "noa_retirement_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_timesheet": 2,
                "noa_timesheet_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_leave": 2,
                "noa_leave_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "payment_voucher_number": 4444,
                "financial_year_start_month": 1,
                "financial_year_end_month": 1,
                "month_start_day": 1,
                "month_end_day": 31,
                "last_payment_voucher_number": null,
                "hr_year_start_month": 1,
                "hr_year_end_month": 1,
                "leave_type_setup": [
                    "sick: 2",
                    "bereavement: 2",
                    "unpaid: 2",
                    "study: 2",
                    "vacation: 2",
                    "compassionate: 2",
                    "maternity: 2",
                    "paternity: 2",
                    "junior_staff: 2",
                    "senior_staff: 2"
                ],
                "work_hour_per_day": [
                    "monday: 8",
                    "tuesday: 8",
                    "wednesday: 8",
                    "thursday: 8",
                    "friday: 8",
                    "saturday: 8",
                    "sunday: 8"
                ],
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "chart_of_account": [
                {
                    "id": 1,
                    "organization_id": 5,
                    "project_id": null,
                    "created_by": 1,
                    "type": "oca",
                    "code": "333",
                    "description": "Nass",
                    "created_at": "2024-03-03T21:46:10.000000Z",
                    "updated_at": "2024-03-03T21:46:10.000000Z",
                    "deleted_at": null
                }
            ]
        }
    ]
}
 

Request      

GET api/organizations/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Asset Example: 18

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/organizations/16" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"culpa\",
    \"email\": \"toy.keyshawn@example.org\",
    \"phone_number\": \"nemo\",
    \"registration_number\": \"molestiae\",
    \"country\": \"repellendus\",
    \"state\": \"nemo\",
    \"city\": \"nulla\",
    \"postcode\": \"iusto\",
    \"address\": \"eos\",
    \"website\": \"http:\\/\\/predovic.com\\/at-cupiditate-quia-eius-omnis-vel-inventore.html\",
    \"thematic_areas\": [
        \"vitae\"
    ],
    \"organization_color\": \"est\",
    \"organization_logo\": \"dicta\",
    \"noa_requisition\": 14,
    \"noa_requisition_names\": [
        \"sit\"
    ],
    \"noa_retirement\": 6,
    \"noa_retirement_names\": [
        \"ducimus\"
    ],
    \"noa_leave\": 20,
    \"noa_leave_names\": [
        \"expedita\"
    ],
    \"noa_timesheet\": 20,
    \"noa_timesheet_names\": [
        \"dolor\"
    ],
    \"financial_year_start_month\": 1,
    \"financial_year_end_month\": 11,
    \"payment_voucher_number\": 13,
    \"month_start_day\": 18,
    \"month_end_day\": 4,
    \"hr_year_start_month\": 17,
    \"hr_year_end_month\": 7,
    \"account_codes\": [
        {
            \"id\": 15,
            \"code\": \"aliquam\",
            \"description\": \"Dolores qui magnam quia hic voluptatibus nobis laudantium.\"
        }
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/organizations/16"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "culpa",
    "email": "toy.keyshawn@example.org",
    "phone_number": "nemo",
    "registration_number": "molestiae",
    "country": "repellendus",
    "state": "nemo",
    "city": "nulla",
    "postcode": "iusto",
    "address": "eos",
    "website": "http:\/\/predovic.com\/at-cupiditate-quia-eius-omnis-vel-inventore.html",
    "thematic_areas": [
        "vitae"
    ],
    "organization_color": "est",
    "organization_logo": "dicta",
    "noa_requisition": 14,
    "noa_requisition_names": [
        "sit"
    ],
    "noa_retirement": 6,
    "noa_retirement_names": [
        "ducimus"
    ],
    "noa_leave": 20,
    "noa_leave_names": [
        "expedita"
    ],
    "noa_timesheet": 20,
    "noa_timesheet_names": [
        "dolor"
    ],
    "financial_year_start_month": 1,
    "financial_year_end_month": 11,
    "payment_voucher_number": 13,
    "month_start_day": 18,
    "month_end_day": 4,
    "hr_year_start_month": 17,
    "hr_year_end_month": 7,
    "account_codes": [
        {
            "id": 15,
            "code": "aliquam",
            "description": "Dolores qui magnam quia hic voluptatibus nobis laudantium."
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/organizations/16';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'culpa',
            'email' => 'toy.keyshawn@example.org',
            'phone_number' => 'nemo',
            'registration_number' => 'molestiae',
            'country' => 'repellendus',
            'state' => 'nemo',
            'city' => 'nulla',
            'postcode' => 'iusto',
            'address' => 'eos',
            'website' => 'http://predovic.com/at-cupiditate-quia-eius-omnis-vel-inventore.html',
            'thematic_areas' => [
                'vitae',
            ],
            'organization_color' => 'est',
            'organization_logo' => 'dicta',
            'noa_requisition' => 14,
            'noa_requisition_names' => [
                'sit',
            ],
            'noa_retirement' => 6,
            'noa_retirement_names' => [
                'ducimus',
            ],
            'noa_leave' => 20,
            'noa_leave_names' => [
                'expedita',
            ],
            'noa_timesheet' => 20,
            'noa_timesheet_names' => [
                'dolor',
            ],
            'financial_year_start_month' => 1,
            'financial_year_end_month' => 11,
            'payment_voucher_number' => 13,
            'month_start_day' => 18,
            'month_end_day' => 4,
            'hr_year_start_month' => 17,
            'hr_year_end_month' => 7,
            'account_codes' => [
                [
                    'id' => 15,
                    'code' => 'aliquam',
                    'description' => 'Dolores qui magnam quia hic voluptatibus nobis laudantium.',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/organizations/16'
payload = {
    "name": "culpa",
    "email": "toy.keyshawn@example.org",
    "phone_number": "nemo",
    "registration_number": "molestiae",
    "country": "repellendus",
    "state": "nemo",
    "city": "nulla",
    "postcode": "iusto",
    "address": "eos",
    "website": "http:\/\/predovic.com\/at-cupiditate-quia-eius-omnis-vel-inventore.html",
    "thematic_areas": [
        "vitae"
    ],
    "organization_color": "est",
    "organization_logo": "dicta",
    "noa_requisition": 14,
    "noa_requisition_names": [
        "sit"
    ],
    "noa_retirement": 6,
    "noa_retirement_names": [
        "ducimus"
    ],
    "noa_leave": 20,
    "noa_leave_names": [
        "expedita"
    ],
    "noa_timesheet": 20,
    "noa_timesheet_names": [
        "dolor"
    ],
    "financial_year_start_month": 1,
    "financial_year_end_month": 11,
    "payment_voucher_number": 13,
    "month_start_day": 18,
    "month_end_day": 4,
    "hr_year_start_month": 17,
    "hr_year_end_month": 7,
    "account_codes": [
        {
            "id": 15,
            "code": "aliquam",
            "description": "Dolores qui magnam quia hic voluptatibus nobis laudantium."
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 5,
            "name": "Test organization",
            "email": "testorganization@cithar.com",
            "phone_number": "09053003200",
            "registration_number": "0099890098",
            "country": "Nigeria",
            "state": "Enugu",
            "city": "Independence Layout",
            "postcode": "40001",
            "address": "28 avenue street",
            "sector": null,
            "website": "https://www.cithar.com",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "subscription_plan": {
                "id": 1,
                "organization_id": 5,
                "payment_reference": null,
                "start_date": "2024-03-03",
                "end_date": "2024-04-03",
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "app_configuration": {
                "id": 1,
                "organization_id": 5,
                "organization_color": "green",
                "organization_logo": null,
                "thematic_areas": [
                    "No Poverty",
                    "Gender Equality",
                    "Quality Education"
                ],
                "noa_requisition": 2,
                "noa_requisition_names": [
                    "admin level 2",
                    "admin level 1"
                ],
                "noa_retirement": 2,
                "noa_retirement_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_timesheet": 2,
                "noa_timesheet_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_leave": 2,
                "noa_leave_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "payment_voucher_number": 4444,
                "financial_year_start_month": 1,
                "financial_year_end_month": 1,
                "month_start_day": 1,
                "month_end_day": 31,
                "last_payment_voucher_number": null,
                "hr_year_start_month": 1,
                "hr_year_end_month": 1,
                "leave_type_setup": [
                    "sick: 2",
                    "bereavement: 2",
                    "unpaid: 2",
                    "study: 2",
                    "vacation: 2",
                    "compassionate: 2",
                    "maternity: 2",
                    "paternity: 2",
                    "junior_staff: 2",
                    "senior_staff: 2"
                ],
                "work_hour_per_day": [
                    "monday: 8",
                    "tuesday: 8",
                    "wednesday: 8",
                    "thursday: 8",
                    "friday: 8",
                    "saturday: 8",
                    "sunday: 8"
                ],
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "chart_of_account": [
                {
                    "id": 1,
                    "organization_id": 5,
                    "project_id": null,
                    "created_by": 1,
                    "type": "oca",
                    "code": "333",
                    "description": "Nass",
                    "created_at": "2024-03-03T21:46:10.000000Z",
                    "updated_at": "2024-03-03T21:46:10.000000Z",
                    "deleted_at": null
                }
            ]
        },
        {
            "id": 5,
            "name": "Test organization",
            "email": "testorganization@cithar.com",
            "phone_number": "09053003200",
            "registration_number": "0099890098",
            "country": "Nigeria",
            "state": "Enugu",
            "city": "Independence Layout",
            "postcode": "40001",
            "address": "28 avenue street",
            "sector": null,
            "website": "https://www.cithar.com",
            "created_at": "2024-03-03T21:46:10.000000Z",
            "updated_at": "2024-03-03T21:46:10.000000Z",
            "deleted_at": null,
            "subscription_plan": {
                "id": 1,
                "organization_id": 5,
                "payment_reference": null,
                "start_date": "2024-03-03",
                "end_date": "2024-04-03",
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "app_configuration": {
                "id": 1,
                "organization_id": 5,
                "organization_color": "green",
                "organization_logo": null,
                "thematic_areas": [
                    "No Poverty",
                    "Gender Equality",
                    "Quality Education"
                ],
                "noa_requisition": 2,
                "noa_requisition_names": [
                    "admin level 2",
                    "admin level 1"
                ],
                "noa_retirement": 2,
                "noa_retirement_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_timesheet": 2,
                "noa_timesheet_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "noa_leave": 2,
                "noa_leave_names": [
                    "admin level 1",
                    "admin level 2"
                ],
                "payment_voucher_number": 4444,
                "financial_year_start_month": 1,
                "financial_year_end_month": 1,
                "month_start_day": 1,
                "month_end_day": 31,
                "last_payment_voucher_number": null,
                "hr_year_start_month": 1,
                "hr_year_end_month": 1,
                "leave_type_setup": [
                    "sick: 2",
                    "bereavement: 2",
                    "unpaid: 2",
                    "study: 2",
                    "vacation: 2",
                    "compassionate: 2",
                    "maternity: 2",
                    "paternity: 2",
                    "junior_staff: 2",
                    "senior_staff: 2"
                ],
                "work_hour_per_day": [
                    "monday: 8",
                    "tuesday: 8",
                    "wednesday: 8",
                    "thursday: 8",
                    "friday: 8",
                    "saturday: 8",
                    "sunday: 8"
                ],
                "created_at": "2024-03-03T21:46:10.000000Z",
                "updated_at": "2024-03-03T21:46:10.000000Z",
                "deleted_at": null
            },
            "chart_of_account": [
                {
                    "id": 1,
                    "organization_id": 5,
                    "project_id": null,
                    "created_by": 1,
                    "type": "oca",
                    "code": "333",
                    "description": "Nass",
                    "created_at": "2024-03-03T21:46:10.000000Z",
                    "updated_at": "2024-03-03T21:46:10.000000Z",
                    "deleted_at": null
                }
            ]
        }
    ]
}
 

Request      

PUT api/organizations/{id}

PATCH api/organizations/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Organization Example: 16

Body Parameters

name   string  optional  

Example: culpa

email   string  optional  

Must be a valid email address. Example: toy.keyshawn@example.org

phone_number   string  optional  

Example: nemo

registration_number   string  optional  

Example: molestiae

country   string  optional  

Example: repellendus

state   string  optional  

Example: nemo

city   string  optional  

Example: nulla

postcode   string  optional  

Example: iusto

address   string  optional  

Example: eos

website   string  optional  

Must be a valid URL. Example: http://predovic.com/at-cupiditate-quia-eius-omnis-vel-inventore.html

thematic_areas   string[]  optional  
account_codes   object[]  optional  
id   integer  optional  

Example: 15

code   string  optional  

This field is required when account_codes is present. Example: aliquam

description   string  optional  

This field is required when account_codes is present. Example: Dolores qui magnam quia hic voluptatibus nobis laudantium.

organization_color   string  optional  

Example: est

organization_logo   string  optional  

Example: dicta

noa_requisition   integer  optional  

Example: 14

noa_requisition_names   string[]  optional  

The name of an existing record in the roles table.

noa_retirement   integer  optional  

Example: 6

noa_retirement_names   string[]  optional  

The name of an existing record in the roles table.

noa_leave   integer  optional  

Example: 20

noa_leave_names   string[]  optional  

The name of an existing record in the roles table.

noa_timesheet   integer  optional  

Example: 20

noa_timesheet_names   string[]  optional  

The name of an existing record in the roles table.

financial_year_start_month   integer  optional  

Example: 1

financial_year_end_month   integer  optional  

Example: 11

payment_voucher_number   integer  optional  

Example: 13

month_start_day   integer  optional  

Example: 18

month_end_day   integer  optional  

Example: 4

hr_year_start_month   integer  optional  

Example: 17

hr_year_end_month   integer  optional  

Example: 7

leave_type_setup   object  optional  
work_hour_per_day   object  optional  

Remove the specified Holiday.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/organizations/7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/organizations/7"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/organizations/7';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/organizations/7'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request      

DELETE api/organizations/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Holiday Example: 7

View the specified organization resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/organization_details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 17
}"
const url = new URL(
    "https://api.cithar.com/api/organization_details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 17
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/organization_details';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'organization_id' => 17,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/organization_details'
payload = {
    "organization_id": 17
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/organization_details could not be found."
}
 

Request      

GET api/organization_details

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

organization_id   integer   

The id of an existing record in the organizations table. Example: 17

Update the specified organization resource.

requires authentication

Example request:
curl --request PATCH \
    "https://api.cithar.com/api/organization_details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 19,
    \"name\": \"eum\",
    \"email\": \"dbeer@example.com\",
    \"phone_number\": \"magni\",
    \"registration_number\": \"omnis\",
    \"country\": \"ullam\",
    \"state\": \"maxime\",
    \"city\": \"vitae\",
    \"postcode\": \"consectetur\",
    \"address\": \"et\",
    \"website\": \"http:\\/\\/www.king.com\\/dolore-commodi-sapiente-quidem-magnam-quis-quis-enim\",
    \"thematic_areas\": [
        \"minima\"
    ],
    \"organization_color\": \"sit\",
    \"organization_logo\": \"tenetur\",
    \"noa_requisition\": 15,
    \"noa_requisition_names\": [
        \"blanditiis\"
    ],
    \"noa_retirement\": 11,
    \"noa_retirement_names\": [
        \"sunt\"
    ],
    \"noa_leave\": 3,
    \"noa_leave_names\": [
        \"odit\"
    ],
    \"noa_timesheet\": 6,
    \"noa_timesheet_names\": [
        \"ea\"
    ],
    \"financial_year_start_month\": 5,
    \"financial_year_end_month\": 19,
    \"payment_voucher_number\": 16,
    \"month_start_day\": 4,
    \"month_end_day\": 1,
    \"hr_year_start_month\": 16,
    \"hr_year_end_month\": 7,
    \"account_codes\": [
        {
            \"id\": 12,
            \"code\": \"aut\",
            \"description\": \"Voluptatem consequatur eos laboriosam tempore mollitia quasi.\"
        }
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/organization_details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 19,
    "name": "eum",
    "email": "dbeer@example.com",
    "phone_number": "magni",
    "registration_number": "omnis",
    "country": "ullam",
    "state": "maxime",
    "city": "vitae",
    "postcode": "consectetur",
    "address": "et",
    "website": "http:\/\/www.king.com\/dolore-commodi-sapiente-quidem-magnam-quis-quis-enim",
    "thematic_areas": [
        "minima"
    ],
    "organization_color": "sit",
    "organization_logo": "tenetur",
    "noa_requisition": 15,
    "noa_requisition_names": [
        "blanditiis"
    ],
    "noa_retirement": 11,
    "noa_retirement_names": [
        "sunt"
    ],
    "noa_leave": 3,
    "noa_leave_names": [
        "odit"
    ],
    "noa_timesheet": 6,
    "noa_timesheet_names": [
        "ea"
    ],
    "financial_year_start_month": 5,
    "financial_year_end_month": 19,
    "payment_voucher_number": 16,
    "month_start_day": 4,
    "month_end_day": 1,
    "hr_year_start_month": 16,
    "hr_year_end_month": 7,
    "account_codes": [
        {
            "id": 12,
            "code": "aut",
            "description": "Voluptatem consequatur eos laboriosam tempore mollitia quasi."
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/organization_details';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'organization_id' => 19,
            'name' => 'eum',
            'email' => 'dbeer@example.com',
            'phone_number' => 'magni',
            'registration_number' => 'omnis',
            'country' => 'ullam',
            'state' => 'maxime',
            'city' => 'vitae',
            'postcode' => 'consectetur',
            'address' => 'et',
            'website' => 'http://www.king.com/dolore-commodi-sapiente-quidem-magnam-quis-quis-enim',
            'thematic_areas' => [
                'minima',
            ],
            'organization_color' => 'sit',
            'organization_logo' => 'tenetur',
            'noa_requisition' => 15,
            'noa_requisition_names' => [
                'blanditiis',
            ],
            'noa_retirement' => 11,
            'noa_retirement_names' => [
                'sunt',
            ],
            'noa_leave' => 3,
            'noa_leave_names' => [
                'odit',
            ],
            'noa_timesheet' => 6,
            'noa_timesheet_names' => [
                'ea',
            ],
            'financial_year_start_month' => 5,
            'financial_year_end_month' => 19,
            'payment_voucher_number' => 16,
            'month_start_day' => 4,
            'month_end_day' => 1,
            'hr_year_start_month' => 16,
            'hr_year_end_month' => 7,
            'account_codes' => [
                [
                    'id' => 12,
                    'code' => 'aut',
                    'description' => 'Voluptatem consequatur eos laboriosam tempore mollitia quasi.',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/organization_details'
payload = {
    "organization_id": 19,
    "name": "eum",
    "email": "dbeer@example.com",
    "phone_number": "magni",
    "registration_number": "omnis",
    "country": "ullam",
    "state": "maxime",
    "city": "vitae",
    "postcode": "consectetur",
    "address": "et",
    "website": "http:\/\/www.king.com\/dolore-commodi-sapiente-quidem-magnam-quis-quis-enim",
    "thematic_areas": [
        "minima"
    ],
    "organization_color": "sit",
    "organization_logo": "tenetur",
    "noa_requisition": 15,
    "noa_requisition_names": [
        "blanditiis"
    ],
    "noa_retirement": 11,
    "noa_retirement_names": [
        "sunt"
    ],
    "noa_leave": 3,
    "noa_leave_names": [
        "odit"
    ],
    "noa_timesheet": 6,
    "noa_timesheet_names": [
        "ea"
    ],
    "financial_year_start_month": 5,
    "financial_year_end_month": 19,
    "payment_voucher_number": 16,
    "month_start_day": 4,
    "month_end_day": 1,
    "hr_year_start_month": 16,
    "hr_year_end_month": 7,
    "account_codes": [
        {
            "id": 12,
            "code": "aut",
            "description": "Voluptatem consequatur eos laboriosam tempore mollitia quasi."
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Request      

PATCH api/organization_details

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

organization_id   integer   

The id of an existing record in the organizations table. Example: 19

name   string  optional  

Example: eum

email   string  optional  

Must be a valid email address. Example: dbeer@example.com

phone_number   string  optional  

Example: magni

registration_number   string  optional  

Example: omnis

country   string  optional  

Example: ullam

state   string  optional  

Example: maxime

city   string  optional  

Example: vitae

postcode   string  optional  

Example: consectetur

address   string  optional  

Example: et

website   string  optional  

Must be a valid URL. Example: http://www.king.com/dolore-commodi-sapiente-quidem-magnam-quis-quis-enim

thematic_areas   string[]  optional  
account_codes   object[]  optional  
id   integer  optional  

Example: 12

code   string  optional  

This field is required when account_codes is present. Example: aut

description   string  optional  

This field is required when account_codes is present. Example: Voluptatem consequatur eos laboriosam tempore mollitia quasi.

organization_color   string  optional  

Example: sit

organization_logo   string  optional  

Example: tenetur

noa_requisition   integer  optional  

Example: 15

noa_requisition_names   string[]  optional  

The name of an existing record in the roles table.

noa_retirement   integer  optional  

Example: 11

noa_retirement_names   string[]  optional  

The name of an existing record in the roles table.

noa_leave   integer  optional  

Example: 3

noa_leave_names   string[]  optional  

The name of an existing record in the roles table.

noa_timesheet   integer  optional  

Example: 6

noa_timesheet_names   string[]  optional  

The name of an existing record in the roles table.

financial_year_start_month   integer  optional  

Example: 5

financial_year_end_month   integer  optional  

Example: 19

payment_voucher_number   integer  optional  

Example: 16

month_start_day   integer  optional  

Example: 4

month_end_day   integer  optional  

Example: 1

hr_year_start_month   integer  optional  

Example: 16

hr_year_end_month   integer  optional  

Example: 7

leave_type_setup   object  optional  
work_hour_per_day   object  optional  

Get approver sequence.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/approval_sequence" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"request_type\": \"timesheet\",
    \"per_page\": 11
}"
const url = new URL(
    "https://api.cithar.com/api/approval_sequence"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "request_type": "timesheet",
    "per_page": 11
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/approval_sequence';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'request_type' => 'timesheet',
            'per_page' => 11,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/approval_sequence'
payload = {
    "request_type": "timesheet",
    "per_page": 11
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/approval_sequence could not be found."
}
 

Request      

GET api/approval_sequence

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

request_type   string   

Example: timesheet

Must be one of:
  • leave
  • requisition
  • retirement
  • timesheet
per_page   integer  optional  

Example: 11

Project Endpoints

Display a listing of Projects.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/projects?term=perspiciatis&per_page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/projects"
);

const params = {
    "term": "perspiciatis",
    "per_page": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/projects';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'term' => 'perspiciatis',
            'per_page' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/projects'
params = {
  'term': 'perspiciatis',
  'per_page': '1',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 12,
            "created_by": 4,
            "name": "OVC",
            "summary": "Pariatur Iste recus",
            "funder_name": "Brenden Richardson",
            "funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "category": [
                "Quality Education"
            ],
            "project_amount": 50000000,
            "start_date": "2024-03-01",
            "end_date": "2025-03-01",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-13T10:10:00.000000Z",
            "deleted_at": null,
            "project_durations": [
                {
                    "id": 1,
                    "budget": "50000000",
                    "start_date": "2024-03-01",
                    "end_date": "2025-03-01"
                }
            ],
            "pca": [
                {
                    "id": 9,
                    "type": "pca",
                    "code": "22",
                    "description": "Amet nihil quod omn"
                },
                {
                    "id": 48,
                    "type": "pca",
                    "code": "53654fv",
                    "description": "operations"
                }
            ],
            "activities": [
                {
                    "id": 1,
                    "title": "training",
                    "start_date": "2024-03-02",
                    "end_date": "2024-03-05"
                },
                {
                    "id": 2,
                    "title": "runing",
                    "start_date": "2024-03-08",
                    "end_date": "2024-03-12"
                }
            ],
            "project_users_names": [
                {
                    "user_id": 4,
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                },
                {
                    "user_id": 24,
                    "first_name": "jennifer",
                    "middle_name": "Galvin Hall",
                    "last_name": "Ugwuanyi"
                },
                {
                    "user_id": 25,
                    "first_name": "Irene",
                    "middle_name": "Nneka",
                    "last_name": "ajah"
                },
                {
                    "user_id": 26,
                    "first_name": "uju",
                    "middle_name": "amara",
                    "last_name": "ede"
                }
            ],
            "project_users": [
                {
                    "user_id": 4,
                    "loe": 50
                },
                {
                    "user_id": 24,
                    "loe": 50
                },
                {
                    "user_id": 25,
                    "loe": 30
                },
                {
                    "user_id": 26,
                    "loe": 100
                }
            ]
        },
        {
            "id": 1,
            "organization_id": 12,
            "created_by": 4,
            "name": "OVC",
            "summary": "Pariatur Iste recus",
            "funder_name": "Brenden Richardson",
            "funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "category": [
                "Quality Education"
            ],
            "project_amount": 50000000,
            "start_date": "2024-03-01",
            "end_date": "2025-03-01",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-13T10:10:00.000000Z",
            "deleted_at": null,
            "project_durations": [
                {
                    "id": 1,
                    "budget": "50000000",
                    "start_date": "2024-03-01",
                    "end_date": "2025-03-01"
                }
            ],
            "pca": [
                {
                    "id": 9,
                    "type": "pca",
                    "code": "22",
                    "description": "Amet nihil quod omn"
                },
                {
                    "id": 48,
                    "type": "pca",
                    "code": "53654fv",
                    "description": "operations"
                }
            ],
            "activities": [
                {
                    "id": 1,
                    "title": "training",
                    "start_date": "2024-03-02",
                    "end_date": "2024-03-05"
                },
                {
                    "id": 2,
                    "title": "runing",
                    "start_date": "2024-03-08",
                    "end_date": "2024-03-12"
                }
            ],
            "project_users_names": [
                {
                    "user_id": 4,
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                },
                {
                    "user_id": 24,
                    "first_name": "jennifer",
                    "middle_name": "Galvin Hall",
                    "last_name": "Ugwuanyi"
                },
                {
                    "user_id": 25,
                    "first_name": "Irene",
                    "middle_name": "Nneka",
                    "last_name": "ajah"
                },
                {
                    "user_id": 26,
                    "first_name": "uju",
                    "middle_name": "amara",
                    "last_name": "ede"
                }
            ],
            "project_users": [
                {
                    "user_id": 4,
                    "loe": 50
                },
                {
                    "user_id": 24,
                    "loe": 50
                },
                {
                    "user_id": 25,
                    "loe": 30
                },
                {
                    "user_id": 26,
                    "loe": 100
                }
            ]
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/projects

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

term   string  optional  

Search query parameter for string data type Example: perspiciatis

per_page   integer  optional  

Items per page Example: 1

Store a newly created Project.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/projects" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"hic\",
    \"organization_id\": 6,
    \"summary\": \"cupiditate\",
    \"funder_name\": \"reprehenderit\",
    \"funder_logo\": \"eius\",
    \"category\": [],
    \"created_by\": 13,
    \"project_amount\": \"necessitatibus\",
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2026-01-25T16:32:31\",
    \"project_durations\": [
        {
            \"budget\": \"repellendus\",
            \"start_date\": \"2026-01-25T16:32:31\",
            \"end_date\": \"2026-01-25T16:32:31\"
        }
    ],
    \"account_codes\": [
        {
            \"code\": \"cupiditate\",
            \"description\": \"Et aut quia quos laudantium aliquam deserunt.\"
        }
    ],
    \"activities\": [
        {
            \"title\": \"quibusdam\",
            \"start_date\": \"2026-01-25T16:32:31\",
            \"end_date\": \"2026-01-25T16:32:31\"
        }
    ],
    \"users\": [
        {
            \"user_id\": 19,
            \"loe\": 6
        }
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/projects"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "hic",
    "organization_id": 6,
    "summary": "cupiditate",
    "funder_name": "reprehenderit",
    "funder_logo": "eius",
    "category": [],
    "created_by": 13,
    "project_amount": "necessitatibus",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31",
    "project_durations": [
        {
            "budget": "repellendus",
            "start_date": "2026-01-25T16:32:31",
            "end_date": "2026-01-25T16:32:31"
        }
    ],
    "account_codes": [
        {
            "code": "cupiditate",
            "description": "Et aut quia quos laudantium aliquam deserunt."
        }
    ],
    "activities": [
        {
            "title": "quibusdam",
            "start_date": "2026-01-25T16:32:31",
            "end_date": "2026-01-25T16:32:31"
        }
    ],
    "users": [
        {
            "user_id": 19,
            "loe": 6
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/projects';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'hic',
            'organization_id' => 6,
            'summary' => 'cupiditate',
            'funder_name' => 'reprehenderit',
            'funder_logo' => 'eius',
            'category' => [],
            'created_by' => 13,
            'project_amount' => 'necessitatibus',
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2026-01-25T16:32:31',
            'project_durations' => [
                [
                    'budget' => 'repellendus',
                    'start_date' => '2026-01-25T16:32:31',
                    'end_date' => '2026-01-25T16:32:31',
                ],
            ],
            'account_codes' => [
                [
                    'code' => 'cupiditate',
                    'description' => 'Et aut quia quos laudantium aliquam deserunt.',
                ],
            ],
            'activities' => [
                [
                    'title' => 'quibusdam',
                    'start_date' => '2026-01-25T16:32:31',
                    'end_date' => '2026-01-25T16:32:31',
                ],
            ],
            'users' => [
                [
                    'user_id' => 19,
                    'loe' => 6,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/projects'
payload = {
    "name": "hic",
    "organization_id": 6,
    "summary": "cupiditate",
    "funder_name": "reprehenderit",
    "funder_logo": "eius",
    "category": [],
    "created_by": 13,
    "project_amount": "necessitatibus",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31",
    "project_durations": [
        {
            "budget": "repellendus",
            "start_date": "2026-01-25T16:32:31",
            "end_date": "2026-01-25T16:32:31"
        }
    ],
    "account_codes": [
        {
            "code": "cupiditate",
            "description": "Et aut quia quos laudantium aliquam deserunt."
        }
    ],
    "activities": [
        {
            "title": "quibusdam",
            "start_date": "2026-01-25T16:32:31",
            "end_date": "2026-01-25T16:32:31"
        }
    ],
    "users": [
        {
            "user_id": 19,
            "loe": 6
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 12,
            "created_by": 4,
            "name": "OVC",
            "summary": "Pariatur Iste recus",
            "funder_name": "Brenden Richardson",
            "funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "category": [
                "Quality Education"
            ],
            "project_amount": 50000000,
            "start_date": "2024-03-01",
            "end_date": "2025-03-01",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-13T10:10:00.000000Z",
            "deleted_at": null,
            "project_durations": [
                {
                    "id": 1,
                    "budget": "50000000",
                    "start_date": "2024-03-01",
                    "end_date": "2025-03-01"
                }
            ],
            "pca": [
                {
                    "id": 9,
                    "type": "pca",
                    "code": "22",
                    "description": "Amet nihil quod omn"
                },
                {
                    "id": 48,
                    "type": "pca",
                    "code": "53654fv",
                    "description": "operations"
                }
            ],
            "activities": [
                {
                    "id": 1,
                    "title": "training",
                    "start_date": "2024-03-02",
                    "end_date": "2024-03-05"
                },
                {
                    "id": 2,
                    "title": "runing",
                    "start_date": "2024-03-08",
                    "end_date": "2024-03-12"
                }
            ],
            "project_users_names": [
                {
                    "user_id": 4,
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                },
                {
                    "user_id": 24,
                    "first_name": "jennifer",
                    "middle_name": "Galvin Hall",
                    "last_name": "Ugwuanyi"
                },
                {
                    "user_id": 25,
                    "first_name": "Irene",
                    "middle_name": "Nneka",
                    "last_name": "ajah"
                },
                {
                    "user_id": 26,
                    "first_name": "uju",
                    "middle_name": "amara",
                    "last_name": "ede"
                }
            ],
            "project_users": [
                {
                    "user_id": 4,
                    "loe": 50
                },
                {
                    "user_id": 24,
                    "loe": 50
                },
                {
                    "user_id": 25,
                    "loe": 30
                },
                {
                    "user_id": 26,
                    "loe": 100
                }
            ]
        },
        {
            "id": 1,
            "organization_id": 12,
            "created_by": 4,
            "name": "OVC",
            "summary": "Pariatur Iste recus",
            "funder_name": "Brenden Richardson",
            "funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "category": [
                "Quality Education"
            ],
            "project_amount": 50000000,
            "start_date": "2024-03-01",
            "end_date": "2025-03-01",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-13T10:10:00.000000Z",
            "deleted_at": null,
            "project_durations": [
                {
                    "id": 1,
                    "budget": "50000000",
                    "start_date": "2024-03-01",
                    "end_date": "2025-03-01"
                }
            ],
            "pca": [
                {
                    "id": 9,
                    "type": "pca",
                    "code": "22",
                    "description": "Amet nihil quod omn"
                },
                {
                    "id": 48,
                    "type": "pca",
                    "code": "53654fv",
                    "description": "operations"
                }
            ],
            "activities": [
                {
                    "id": 1,
                    "title": "training",
                    "start_date": "2024-03-02",
                    "end_date": "2024-03-05"
                },
                {
                    "id": 2,
                    "title": "runing",
                    "start_date": "2024-03-08",
                    "end_date": "2024-03-12"
                }
            ],
            "project_users_names": [
                {
                    "user_id": 4,
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                },
                {
                    "user_id": 24,
                    "first_name": "jennifer",
                    "middle_name": "Galvin Hall",
                    "last_name": "Ugwuanyi"
                },
                {
                    "user_id": 25,
                    "first_name": "Irene",
                    "middle_name": "Nneka",
                    "last_name": "ajah"
                },
                {
                    "user_id": 26,
                    "first_name": "uju",
                    "middle_name": "amara",
                    "last_name": "ede"
                }
            ],
            "project_users": [
                {
                    "user_id": 4,
                    "loe": 50
                },
                {
                    "user_id": 24,
                    "loe": 50
                },
                {
                    "user_id": 25,
                    "loe": 30
                },
                {
                    "user_id": 26,
                    "loe": 100
                }
            ]
        }
    ]
}
 

Request      

POST api/projects

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: hic

organization_id   integer   

The id of an existing record in the organizations table. Example: 6

summary   string   

Example: cupiditate

funder_name   string   

Example: reprehenderit

funder_logo   string   

Example: eius

category   object   
created_by   integer   

The id of an existing record in the users table. Example: 13

project_amount   string   

Example: necessitatibus

start_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

project_durations   object[]  optional  
budget   string  optional  

Example: repellendus

start_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

account_codes   object[]  optional  
code   string  optional  

Example: cupiditate

description   string  optional  

Example: Et aut quia quos laudantium aliquam deserunt.

activities   object[]  optional  
title   string  optional  

Example: quibusdam

start_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

users   object[]  optional  
user_id   integer  optional  

The id of an existing record in the users table. Example: 19

loe   integer  optional  

Example: 6

Display the specified Project.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/projects/7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/projects/7"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/projects/7';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/projects/7'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 12,
            "created_by": 4,
            "name": "OVC",
            "summary": "Pariatur Iste recus",
            "funder_name": "Brenden Richardson",
            "funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "category": [
                "Quality Education"
            ],
            "project_amount": 50000000,
            "start_date": "2024-03-01",
            "end_date": "2025-03-01",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-13T10:10:00.000000Z",
            "deleted_at": null,
            "project_durations": [
                {
                    "id": 1,
                    "budget": "50000000",
                    "start_date": "2024-03-01",
                    "end_date": "2025-03-01"
                }
            ],
            "pca": [
                {
                    "id": 9,
                    "type": "pca",
                    "code": "22",
                    "description": "Amet nihil quod omn"
                },
                {
                    "id": 48,
                    "type": "pca",
                    "code": "53654fv",
                    "description": "operations"
                }
            ],
            "activities": [
                {
                    "id": 1,
                    "title": "training",
                    "start_date": "2024-03-02",
                    "end_date": "2024-03-05"
                },
                {
                    "id": 2,
                    "title": "runing",
                    "start_date": "2024-03-08",
                    "end_date": "2024-03-12"
                }
            ],
            "project_users_names": [
                {
                    "user_id": 4,
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                },
                {
                    "user_id": 24,
                    "first_name": "jennifer",
                    "middle_name": "Galvin Hall",
                    "last_name": "Ugwuanyi"
                },
                {
                    "user_id": 25,
                    "first_name": "Irene",
                    "middle_name": "Nneka",
                    "last_name": "ajah"
                },
                {
                    "user_id": 26,
                    "first_name": "uju",
                    "middle_name": "amara",
                    "last_name": "ede"
                }
            ],
            "project_users": [
                {
                    "user_id": 4,
                    "loe": 50
                },
                {
                    "user_id": 24,
                    "loe": 50
                },
                {
                    "user_id": 25,
                    "loe": 30
                },
                {
                    "user_id": 26,
                    "loe": 100
                }
            ]
        },
        {
            "id": 1,
            "organization_id": 12,
            "created_by": 4,
            "name": "OVC",
            "summary": "Pariatur Iste recus",
            "funder_name": "Brenden Richardson",
            "funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "category": [
                "Quality Education"
            ],
            "project_amount": 50000000,
            "start_date": "2024-03-01",
            "end_date": "2025-03-01",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-13T10:10:00.000000Z",
            "deleted_at": null,
            "project_durations": [
                {
                    "id": 1,
                    "budget": "50000000",
                    "start_date": "2024-03-01",
                    "end_date": "2025-03-01"
                }
            ],
            "pca": [
                {
                    "id": 9,
                    "type": "pca",
                    "code": "22",
                    "description": "Amet nihil quod omn"
                },
                {
                    "id": 48,
                    "type": "pca",
                    "code": "53654fv",
                    "description": "operations"
                }
            ],
            "activities": [
                {
                    "id": 1,
                    "title": "training",
                    "start_date": "2024-03-02",
                    "end_date": "2024-03-05"
                },
                {
                    "id": 2,
                    "title": "runing",
                    "start_date": "2024-03-08",
                    "end_date": "2024-03-12"
                }
            ],
            "project_users_names": [
                {
                    "user_id": 4,
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                },
                {
                    "user_id": 24,
                    "first_name": "jennifer",
                    "middle_name": "Galvin Hall",
                    "last_name": "Ugwuanyi"
                },
                {
                    "user_id": 25,
                    "first_name": "Irene",
                    "middle_name": "Nneka",
                    "last_name": "ajah"
                },
                {
                    "user_id": 26,
                    "first_name": "uju",
                    "middle_name": "amara",
                    "last_name": "ede"
                }
            ],
            "project_users": [
                {
                    "user_id": 4,
                    "loe": 50
                },
                {
                    "user_id": 24,
                    "loe": 50
                },
                {
                    "user_id": 25,
                    "loe": 30
                },
                {
                    "user_id": 26,
                    "loe": 100
                }
            ]
        }
    ]
}
 

Request      

GET api/projects/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Project Example: 7

Update the specified Project.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/projects/8" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 14,
    \"name\": \"accusamus\",
    \"summary\": \"voluptas\",
    \"funder_name\": \"natus\",
    \"funder_logo\": \"debitis\",
    \"created_by\": 20,
    \"project_amount\": \"aspernatur\",
    \"project_durations\": [
        {
            \"id\": 16,
            \"budget\": \"et\",
            \"start_date\": \"2026-01-25T16:32:31\",
            \"end_date\": \"2026-01-25T16:32:31\"
        }
    ],
    \"account_codes\": [
        {
            \"id\": 11,
            \"code\": \"aut\",
            \"description\": \"Delectus perspiciatis eveniet dolores ut sed sed.\"
        }
    ],
    \"activities\": [
        {
            \"id\": 2,
            \"title\": \"voluptatum\",
            \"start_date\": \"2026-01-25T16:32:31\",
            \"end_date\": \"2026-01-25T16:32:31\"
        }
    ],
    \"users\": [
        {
            \"user_id\": 19,
            \"loe\": 7
        }
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/projects/8"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 14,
    "name": "accusamus",
    "summary": "voluptas",
    "funder_name": "natus",
    "funder_logo": "debitis",
    "created_by": 20,
    "project_amount": "aspernatur",
    "project_durations": [
        {
            "id": 16,
            "budget": "et",
            "start_date": "2026-01-25T16:32:31",
            "end_date": "2026-01-25T16:32:31"
        }
    ],
    "account_codes": [
        {
            "id": 11,
            "code": "aut",
            "description": "Delectus perspiciatis eveniet dolores ut sed sed."
        }
    ],
    "activities": [
        {
            "id": 2,
            "title": "voluptatum",
            "start_date": "2026-01-25T16:32:31",
            "end_date": "2026-01-25T16:32:31"
        }
    ],
    "users": [
        {
            "user_id": 19,
            "loe": 7
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/projects/8';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'organization_id' => 14,
            'name' => 'accusamus',
            'summary' => 'voluptas',
            'funder_name' => 'natus',
            'funder_logo' => 'debitis',
            'created_by' => 20,
            'project_amount' => 'aspernatur',
            'project_durations' => [
                [
                    'id' => 16,
                    'budget' => 'et',
                    'start_date' => '2026-01-25T16:32:31',
                    'end_date' => '2026-01-25T16:32:31',
                ],
            ],
            'account_codes' => [
                [
                    'id' => 11,
                    'code' => 'aut',
                    'description' => 'Delectus perspiciatis eveniet dolores ut sed sed.',
                ],
            ],
            'activities' => [
                [
                    'id' => 2,
                    'title' => 'voluptatum',
                    'start_date' => '2026-01-25T16:32:31',
                    'end_date' => '2026-01-25T16:32:31',
                ],
            ],
            'users' => [
                [
                    'user_id' => 19,
                    'loe' => 7,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/projects/8'
payload = {
    "organization_id": 14,
    "name": "accusamus",
    "summary": "voluptas",
    "funder_name": "natus",
    "funder_logo": "debitis",
    "created_by": 20,
    "project_amount": "aspernatur",
    "project_durations": [
        {
            "id": 16,
            "budget": "et",
            "start_date": "2026-01-25T16:32:31",
            "end_date": "2026-01-25T16:32:31"
        }
    ],
    "account_codes": [
        {
            "id": 11,
            "code": "aut",
            "description": "Delectus perspiciatis eveniet dolores ut sed sed."
        }
    ],
    "activities": [
        {
            "id": 2,
            "title": "voluptatum",
            "start_date": "2026-01-25T16:32:31",
            "end_date": "2026-01-25T16:32:31"
        }
    ],
    "users": [
        {
            "user_id": 19,
            "loe": 7
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 12,
            "created_by": 4,
            "name": "OVC",
            "summary": "Pariatur Iste recus",
            "funder_name": "Brenden Richardson",
            "funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "category": [
                "Quality Education"
            ],
            "project_amount": 50000000,
            "start_date": "2024-03-01",
            "end_date": "2025-03-01",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-13T10:10:00.000000Z",
            "deleted_at": null,
            "project_durations": [
                {
                    "id": 1,
                    "budget": "50000000",
                    "start_date": "2024-03-01",
                    "end_date": "2025-03-01"
                }
            ],
            "pca": [
                {
                    "id": 9,
                    "type": "pca",
                    "code": "22",
                    "description": "Amet nihil quod omn"
                },
                {
                    "id": 48,
                    "type": "pca",
                    "code": "53654fv",
                    "description": "operations"
                }
            ],
            "activities": [
                {
                    "id": 1,
                    "title": "training",
                    "start_date": "2024-03-02",
                    "end_date": "2024-03-05"
                },
                {
                    "id": 2,
                    "title": "runing",
                    "start_date": "2024-03-08",
                    "end_date": "2024-03-12"
                }
            ],
            "project_users_names": [
                {
                    "user_id": 4,
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                },
                {
                    "user_id": 24,
                    "first_name": "jennifer",
                    "middle_name": "Galvin Hall",
                    "last_name": "Ugwuanyi"
                },
                {
                    "user_id": 25,
                    "first_name": "Irene",
                    "middle_name": "Nneka",
                    "last_name": "ajah"
                },
                {
                    "user_id": 26,
                    "first_name": "uju",
                    "middle_name": "amara",
                    "last_name": "ede"
                }
            ],
            "project_users": [
                {
                    "user_id": 4,
                    "loe": 50
                },
                {
                    "user_id": 24,
                    "loe": 50
                },
                {
                    "user_id": 25,
                    "loe": 30
                },
                {
                    "user_id": 26,
                    "loe": 100
                }
            ]
        },
        {
            "id": 1,
            "organization_id": 12,
            "created_by": 4,
            "name": "OVC",
            "summary": "Pariatur Iste recus",
            "funder_name": "Brenden Richardson",
            "funder_logo": "https://res.cloudinary.com/citharerp/image/upload/v1710320999/232227330_4930455253637295_9116007569529616517_n_rqceid_bhjgrm_wyayuh_jhop6e.jpg",
            "category": [
                "Quality Education"
            ],
            "project_amount": 50000000,
            "start_date": "2024-03-01",
            "end_date": "2025-03-01",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-13T10:10:00.000000Z",
            "deleted_at": null,
            "project_durations": [
                {
                    "id": 1,
                    "budget": "50000000",
                    "start_date": "2024-03-01",
                    "end_date": "2025-03-01"
                }
            ],
            "pca": [
                {
                    "id": 9,
                    "type": "pca",
                    "code": "22",
                    "description": "Amet nihil quod omn"
                },
                {
                    "id": 48,
                    "type": "pca",
                    "code": "53654fv",
                    "description": "operations"
                }
            ],
            "activities": [
                {
                    "id": 1,
                    "title": "training",
                    "start_date": "2024-03-02",
                    "end_date": "2024-03-05"
                },
                {
                    "id": 2,
                    "title": "runing",
                    "start_date": "2024-03-08",
                    "end_date": "2024-03-12"
                }
            ],
            "project_users_names": [
                {
                    "user_id": 4,
                    "first_name": "ernest",
                    "middle_name": "shed",
                    "last_name": "chidera"
                },
                {
                    "user_id": 24,
                    "first_name": "jennifer",
                    "middle_name": "Galvin Hall",
                    "last_name": "Ugwuanyi"
                },
                {
                    "user_id": 25,
                    "first_name": "Irene",
                    "middle_name": "Nneka",
                    "last_name": "ajah"
                },
                {
                    "user_id": 26,
                    "first_name": "uju",
                    "middle_name": "amara",
                    "last_name": "ede"
                }
            ],
            "project_users": [
                {
                    "user_id": 4,
                    "loe": 50
                },
                {
                    "user_id": 24,
                    "loe": 50
                },
                {
                    "user_id": 25,
                    "loe": 30
                },
                {
                    "user_id": 26,
                    "loe": 100
                }
            ]
        }
    ]
}
 

Request      

PUT api/projects/{id}

PATCH api/projects/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Project Example: 8

Body Parameters

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 14

name   string  optional  

Example: accusamus

summary   string  optional  

Example: voluptas

funder_name   string  optional  

Example: natus

funder_logo   string  optional  

Example: debitis

category   object  optional  
created_by   integer   

The id of an existing record in the users table. Example: 20

project_amount   string   

Example: aspernatur

project_durations   object[]  optional  
id   integer  optional  

Example: 16

budget   string  optional  

Example: et

start_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

account_codes   object[]  optional  
id   integer  optional  

Example: 11

code   string  optional  

Example: aut

description   string  optional  

Example: Delectus perspiciatis eveniet dolores ut sed sed.

activities   object[]  optional  
id   integer  optional  

Example: 2

title   string  optional  

Example: voluptatum

start_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

users   object[]  optional  
user_id   integer  optional  

The id of an existing record in the users table. Example: 19

loe   integer  optional  

Example: 7

Remove the specified Project.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/projects/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/projects/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/projects/3';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/projects/3'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request      

DELETE api/projects/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Project Example: 3

Display a listing of the Activities.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/activities?per_page=16" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/activities"
);

const params = {
    "per_page": "16",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/activities';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '16',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/activities'
params = {
  'per_page': '16',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 12,
            "project_id": 1,
            "created_by": 3,
            "title": "training",
            "start_date": "2024-03-02",
            "end_date": "2024-03-05",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-05T11:00:47.000000Z",
            "deleted_at": null
        },
        {
            "id": 1,
            "organization_id": 12,
            "project_id": 1,
            "created_by": 3,
            "title": "training",
            "start_date": "2024-03-02",
            "end_date": "2024-03-05",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-05T11:00:47.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/activities

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 16

Store a newly created Activity.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/activities" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 17,
    \"organization_id\": 4,
    \"project_id\": 1,
    \"title\": \"harum\",
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2101-06-23\"
}"
const url = new URL(
    "https://api.cithar.com/api/activities"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 17,
    "organization_id": 4,
    "project_id": 1,
    "title": "harum",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2101-06-23"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/activities';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 17,
            'organization_id' => 4,
            'project_id' => 1,
            'title' => 'harum',
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2101-06-23',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/activities'
payload = {
    "created_by": 17,
    "organization_id": 4,
    "project_id": 1,
    "title": "harum",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2101-06-23"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 12,
            "project_id": 1,
            "created_by": 3,
            "title": "training",
            "start_date": "2024-03-02",
            "end_date": "2024-03-05",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-05T11:00:47.000000Z",
            "deleted_at": null
        },
        {
            "id": 1,
            "organization_id": 12,
            "project_id": 1,
            "created_by": 3,
            "title": "training",
            "start_date": "2024-03-02",
            "end_date": "2024-03-05",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-05T11:00:47.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

POST api/activities

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

created_by   integer   

The id of an existing record in the users table. Example: 17

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 4

project_id   integer   

The id of an existing record in the projects table. Example: 1

title   string   

Example: harum

start_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string   

Must be a valid date. Must be a date after start_date. Example: 2101-06-23

Show the specified Activity.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/activities/quisquam" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/activities/quisquam"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/activities/quisquam';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/activities/quisquam'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 12,
            "project_id": 1,
            "created_by": 3,
            "title": "training",
            "start_date": "2024-03-02",
            "end_date": "2024-03-05",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-05T11:00:47.000000Z",
            "deleted_at": null
        },
        {
            "id": 1,
            "organization_id": 12,
            "project_id": 1,
            "created_by": 3,
            "title": "training",
            "start_date": "2024-03-02",
            "end_date": "2024-03-05",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-05T11:00:47.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/activities/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the activity. Example: quisquam

Update the specified Activity.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/activities/impedit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 8,
    \"organization_id\": 15,
    \"project_id\": 18,
    \"title\": \"repellendus\",
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2026-01-25T16:32:31\"
}"
const url = new URL(
    "https://api.cithar.com/api/activities/impedit"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 8,
    "organization_id": 15,
    "project_id": 18,
    "title": "repellendus",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/activities/impedit';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 8,
            'organization_id' => 15,
            'project_id' => 18,
            'title' => 'repellendus',
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2026-01-25T16:32:31',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/activities/impedit'
payload = {
    "created_by": 8,
    "organization_id": 15,
    "project_id": 18,
    "title": "repellendus",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 12,
            "project_id": 1,
            "created_by": 3,
            "title": "training",
            "start_date": "2024-03-02",
            "end_date": "2024-03-05",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-05T11:00:47.000000Z",
            "deleted_at": null
        },
        {
            "id": 1,
            "organization_id": 12,
            "project_id": 1,
            "created_by": 3,
            "title": "training",
            "start_date": "2024-03-02",
            "end_date": "2024-03-05",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-05T11:00:47.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

PUT api/activities/{id}

PATCH api/activities/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the activity. Example: impedit

Body Parameters

created_by   integer  optional  

The id of an existing record in the users table. Example: 8

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 15

project_id   integer  optional  

The id of an existing record in the projects table. Example: 18

title   string  optional  

Example: repellendus

start_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/activities/ut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/activities/ut"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/activities/ut';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/activities/ut'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 12,
            "project_id": 1,
            "created_by": 3,
            "title": "training",
            "start_date": "2024-03-02",
            "end_date": "2024-03-05",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-05T11:00:47.000000Z",
            "deleted_at": null
        },
        {
            "id": 1,
            "organization_id": 12,
            "project_id": 1,
            "created_by": 3,
            "title": "training",
            "start_date": "2024-03-02",
            "end_date": "2024-03-05",
            "created_at": "2024-03-05T11:00:47.000000Z",
            "updated_at": "2024-03-05T11:00:47.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

DELETE api/activities/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the activity. Example: ut

Add users to a project.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/attach_project_user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"operation\": \"detach\",
    \"project_id\": 5,
    \"users\": [
        {
            \"user_id\": 13,
            \"loe\": 4
        }
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/attach_project_user"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "operation": "detach",
    "project_id": 5,
    "users": [
        {
            "user_id": 13,
            "loe": 4
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/attach_project_user';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'operation' => 'detach',
            'project_id' => 5,
            'users' => [
                [
                    'user_id' => 13,
                    'loe' => 4,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/attach_project_user'
payload = {
    "operation": "detach",
    "project_id": 5,
    "users": [
        {
            "user_id": 13,
            "loe": 4
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/attach_project_user

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

operation   string   

Example: detach

Must be one of:
  • attach
  • detach
project_id   integer   

The id of an existing record in the projects table. Example: 5

users   object[]  optional  

This field is required when operation is attach.

user_id   integer  optional  

The id of an existing record in the users table. This field is required when operation is attach. Example: 13

loe   integer   

Example: 4

user_id   object  optional  

The id of an existing record in the users table. This field is required when operation is detach.

Remove users to a project.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/detach_project_user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"operation\": \"detach\",
    \"project_id\": 1,
    \"users\": [
        {
            \"user_id\": 6,
            \"loe\": 2
        }
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/detach_project_user"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "operation": "detach",
    "project_id": 1,
    "users": [
        {
            "user_id": 6,
            "loe": 2
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/detach_project_user';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'operation' => 'detach',
            'project_id' => 1,
            'users' => [
                [
                    'user_id' => 6,
                    'loe' => 2,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/detach_project_user'
payload = {
    "operation": "detach",
    "project_id": 1,
    "users": [
        {
            "user_id": 6,
            "loe": 2
        }
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/detach_project_user

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

operation   string   

Example: detach

Must be one of:
  • attach
  • detach
project_id   integer   

The id of an existing record in the projects table. Example: 1

users   object[]  optional  

This field is required when operation is attach.

user_id   integer  optional  

The id of an existing record in the users table. This field is required when operation is attach. Example: 6

loe   integer   

Example: 2

user_id   object  optional  

The id of an existing record in the users table. This field is required when operation is detach.

Get Activities by project.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/get_activities_by_project" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": 20
}"
const url = new URL(
    "https://api.cithar.com/api/get_activities_by_project"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "project_id": 20
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_activities_by_project';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'project_id' => 20,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_activities_by_project'
payload = {
    "project_id": 20
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/get_activities_by_project

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

project_id   integer   

Example: 20

Get project a logged-in user is assigned to.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_user_project" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/get_user_project"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_user_project';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_user_project'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_user_project could not be found."
}
 

Request      

GET api/get_user_project

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get Project Gantt Chat.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/project_gantt_chart" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": 2,
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2026-01-25T16:32:31\"
}"
const url = new URL(
    "https://api.cithar.com/api/project_gantt_chart"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "project_id": 2,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/project_gantt_chart';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'project_id' => 2,
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2026-01-25T16:32:31',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/project_gantt_chart'
payload = {
    "project_id": 2,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/project_gantt_chart could not be found."
}
 

Request      

GET api/project_gantt_chart

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

project_id   integer   

The id of an existing record in the projects table. Example: 2

start_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

Remove the specified Project.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_projects" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/get_projects"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_projects';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_projects'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_projects could not be found."
}
 

Request      

GET api/get_projects

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Project Example: 11

Push Notifications Endpoints

Create a new User Device Token

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/store_user_device_token" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 18,
    \"device_token\": \"consequatur\"
}"
const url = new URL(
    "https://api.cithar.com/api/store_user_device_token"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 18,
    "device_token": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/store_user_device_token';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'user_id' => 18,
            'device_token' => 'consequatur',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/store_user_device_token'
payload = {
    "user_id": 18,
    "device_token": "consequatur"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "organization_id": 13,
        "user_id": 20,
        "device_token": "dBOtLU0ZQGEzsy7L46eTBQ:APA91bH5eeEQopaA-w9qRmReX_9wvHiAxBeYb-lAIHqoJ4phmHFU-8wNpGc65VbZa2UMyJTK-oOL4sra7TpYq4xo7N9GC1Y7x_v-77uemypN7fgjFFkuyxM",
        "created_at": "2024-04-27T15:30:47.000000Z",
        "updated_at": "2026-01-23T15:31:34.000000Z",
        "deleted_at": null
    }
}
 

Request      

POST api/store_user_device_token

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_id   integer  optional  

The id of an existing record in the users table. Example: 18

device_token   string  optional  

Example: consequatur

Update a new User Device Token

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/store_user_device_token" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/store_user_device_token"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/store_user_device_token';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/store_user_device_token'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "organization_id": 13,
        "user_id": 20,
        "device_token": "dBOtLU0ZQGEzsy7L46eTBQ:APA91bH5eeEQopaA-w9qRmReX_9wvHiAxBeYb-lAIHqoJ4phmHFU-8wNpGc65VbZa2UMyJTK-oOL4sra7TpYq4xo7N9GC1Y7x_v-77uemypN7fgjFFkuyxM",
        "created_at": "2024-04-27T15:30:47.000000Z",
        "updated_at": "2026-01-23T15:31:34.000000Z",
        "deleted_at": null
    }
}
 

Request      

PUT api/store_user_device_token

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Default function for sending push notification

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/push_notification_message" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/push_notification_message"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/push_notification_message';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/push_notification_message'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/push_notification_message

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Display a listing of the User Push Notification Message.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/push_notification_message?per_page=4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/push_notification_message"
);

const params = {
    "per_page": "4",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/push_notification_message';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/push_notification_message'
params = {
  'per_page': '4',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "organization_id": 13,
            "user_id": 12,
            "title": "Retirement Notification",
            "message": "A new retirement has been created by Kalu\n                    Favour, and is awaiting your approval",
            "is_read": true,
            "created_at": "2024-04-30T09:05:39.000000Z",
            "updated_at": "2024-04-30T09:40:20.000000Z",
            "deleted_at": null
        },
        {
            "id": 1,
            "organization_id": 13,
            "user_id": 12,
            "title": "Retirement Notification",
            "message": "A new retirement has been created by Kalu\n                    Favour, and is awaiting your approval",
            "is_read": true,
            "created_at": "2024-04-30T09:05:39.000000Z",
            "updated_at": "2024-04-30T09:40:20.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/push_notification_message

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 4

Update the group of Push Notification Messages.

requires authentication

Example request:
curl --request PATCH \
    "https://api.cithar.com/api/push_notification_message" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": [
        18
    ],
    \"is_read\": false
}"
const url = new URL(
    "https://api.cithar.com/api/push_notification_message"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": [
        18
    ],
    "is_read": false
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/push_notification_message';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'id' => [
                18,
            ],
            'is_read' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/push_notification_message'
payload = {
    "id": [
        18
    ],
    "is_read": false
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": {
        "id": 1,
        "organization_id": 13,
        "user_id": 12,
        "title": "Retirement Notification",
        "message": "A new retirement has been created by Kalu\n                    Favour, and is awaiting your approval",
        "is_read": true,
        "created_at": "2024-04-30T09:05:39.000000Z",
        "updated_at": "2024-04-30T09:40:20.000000Z",
        "deleted_at": null
    }
}
 

Request      

PATCH api/push_notification_message

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the NFC tag Example: 5

Body Parameters

id   integer[]  optional  

The id of an existing record in the push_notification_messages table.

is_read   boolean  optional  

Example: false

Delete a group of Push Notification Messages.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/push_notification_message/16" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/push_notification_message/16"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/push_notification_message/16';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/push_notification_message/16'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request      

DELETE api/push_notification_message/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the NFC tag Example: 16

Subscription Plan Endpoints

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/subscription_plan" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/subscription_plan"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/subscription_plan';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/subscription_plan'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/subscription_plan could not be found."
}
 

Request      

GET api/subscription_plan

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/subscription_plan" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/subscription_plan"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/subscription_plan';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/subscription_plan'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/subscription_plan

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/subscription_plan/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/subscription_plan/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/subscription_plan/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/subscription_plan/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/subscription_plan/1 could not be found."
}
 

Request      

GET api/subscription_plan/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the subscription plan. Example: 1

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/subscription_plan/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/subscription_plan/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/subscription_plan/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/subscription_plan/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request      

PUT api/subscription_plan/{id}

PATCH api/subscription_plan/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the subscription plan. Example: 1

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/subscription_plan/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/subscription_plan/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/subscription_plan/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/subscription_plan/1'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request      

DELETE api/subscription_plan/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the subscription plan. Example: 1

Tasks Endpoints

Display a listing of the Tasks.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/tasks?per_page=17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/tasks"
);

const params = {
    "per_page": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/tasks';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/tasks'
params = {
  'per_page': '17',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "assigned_to": 4,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "activity_id": 1,
            "status": "done",
            "title": "training",
            "description": "refge4bghufgbuhk",
            "start_date": "2024-03-05",
            "end_date": "2024-03-06",
            "number_of_days": 2,
            "created_at": "2024-03-05T11:21:55.000000Z",
            "updated_at": "2024-03-13T10:11:14.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "assigned_to_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "project_name": "OVC",
            "activity_name": "training"
        },
        {
            "id": 1,
            "assigned_to": 4,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "activity_id": 1,
            "status": "done",
            "title": "training",
            "description": "refge4bghufgbuhk",
            "start_date": "2024-03-05",
            "end_date": "2024-03-06",
            "number_of_days": 2,
            "created_at": "2024-03-05T11:21:55.000000Z",
            "updated_at": "2024-03-13T10:11:14.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "assigned_to_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "project_name": "OVC",
            "activity_name": "training"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/tasks

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 17

Store a newly created Task.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/tasks" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 2,
    \"organization_id\": 15,
    \"project_id\": 14,
    \"activity_id\": 11,
    \"title\": \"doloremque\",
    \"description\": \"Recusandae minima sequi placeat earum odio.\",
    \"assigned_to\": 16,
    \"status\": \"tempora\",
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2026-01-25T16:32:31\"
}"
const url = new URL(
    "https://api.cithar.com/api/tasks"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 2,
    "organization_id": 15,
    "project_id": 14,
    "activity_id": 11,
    "title": "doloremque",
    "description": "Recusandae minima sequi placeat earum odio.",
    "assigned_to": 16,
    "status": "tempora",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/tasks';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 2,
            'organization_id' => 15,
            'project_id' => 14,
            'activity_id' => 11,
            'title' => 'doloremque',
            'description' => 'Recusandae minima sequi placeat earum odio.',
            'assigned_to' => 16,
            'status' => 'tempora',
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2026-01-25T16:32:31',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/tasks'
payload = {
    "created_by": 2,
    "organization_id": 15,
    "project_id": 14,
    "activity_id": 11,
    "title": "doloremque",
    "description": "Recusandae minima sequi placeat earum odio.",
    "assigned_to": 16,
    "status": "tempora",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "assigned_to": 4,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "activity_id": 1,
            "status": "done",
            "title": "training",
            "description": "refge4bghufgbuhk",
            "start_date": "2024-03-05",
            "end_date": "2024-03-06",
            "number_of_days": 2,
            "created_at": "2024-03-05T11:21:55.000000Z",
            "updated_at": "2024-03-13T10:11:14.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "assigned_to_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "project_name": "OVC",
            "activity_name": "training"
        },
        {
            "id": 1,
            "assigned_to": 4,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "activity_id": 1,
            "status": "done",
            "title": "training",
            "description": "refge4bghufgbuhk",
            "start_date": "2024-03-05",
            "end_date": "2024-03-06",
            "number_of_days": 2,
            "created_at": "2024-03-05T11:21:55.000000Z",
            "updated_at": "2024-03-13T10:11:14.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "assigned_to_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "project_name": "OVC",
            "activity_name": "training"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

POST api/tasks

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

created_by   integer   

The id of an existing record in the users table. Example: 2

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 15

project_id   integer   

The id of an existing record in the projects table. Example: 14

activity_id   integer   

The id of an existing record in the activities table. Example: 11

title   string   

Example: doloremque

description   string   

Example: Recusandae minima sequi placeat earum odio.

assigned_to   integer   

The id of an existing record in the users table. Example: 16

status   string   

Example: tempora

start_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string   

Must be a valid date. Example: 2026-01-25T16:32:31

Show the specified Task.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/tasks/19" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/tasks/19"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/tasks/19';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/tasks/19'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "assigned_to": 4,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "activity_id": 1,
            "status": "done",
            "title": "training",
            "description": "refge4bghufgbuhk",
            "start_date": "2024-03-05",
            "end_date": "2024-03-06",
            "number_of_days": 2,
            "created_at": "2024-03-05T11:21:55.000000Z",
            "updated_at": "2024-03-13T10:11:14.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "assigned_to_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "project_name": "OVC",
            "activity_name": "training"
        },
        {
            "id": 1,
            "assigned_to": 4,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "activity_id": 1,
            "status": "done",
            "title": "training",
            "description": "refge4bghufgbuhk",
            "start_date": "2024-03-05",
            "end_date": "2024-03-06",
            "number_of_days": 2,
            "created_at": "2024-03-05T11:21:55.000000Z",
            "updated_at": "2024-03-13T10:11:14.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "assigned_to_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "project_name": "OVC",
            "activity_name": "training"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/tasks/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Task Example: 19

Update the specified Task.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/tasks/18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 3,
    \"organization_id\": 19,
    \"project_id\": 8,
    \"activity_id\": 11,
    \"title\": \"et\",
    \"description\": \"Labore quo esse nesciunt enim aspernatur pariatur inventore.\",
    \"type\": \"multiple\",
    \"assigned_to\": 5,
    \"status\": \"quasi\",
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2026-01-25T16:32:31\"
}"
const url = new URL(
    "https://api.cithar.com/api/tasks/18"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 3,
    "organization_id": 19,
    "project_id": 8,
    "activity_id": 11,
    "title": "et",
    "description": "Labore quo esse nesciunt enim aspernatur pariatur inventore.",
    "type": "multiple",
    "assigned_to": 5,
    "status": "quasi",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/tasks/18';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 3,
            'organization_id' => 19,
            'project_id' => 8,
            'activity_id' => 11,
            'title' => 'et',
            'description' => 'Labore quo esse nesciunt enim aspernatur pariatur inventore.',
            'type' => 'multiple',
            'assigned_to' => 5,
            'status' => 'quasi',
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2026-01-25T16:32:31',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/tasks/18'
payload = {
    "created_by": 3,
    "organization_id": 19,
    "project_id": 8,
    "activity_id": 11,
    "title": "et",
    "description": "Labore quo esse nesciunt enim aspernatur pariatur inventore.",
    "type": "multiple",
    "assigned_to": 5,
    "status": "quasi",
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "assigned_to": 4,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "activity_id": 1,
            "status": "done",
            "title": "training",
            "description": "refge4bghufgbuhk",
            "start_date": "2024-03-05",
            "end_date": "2024-03-06",
            "number_of_days": 2,
            "created_at": "2024-03-05T11:21:55.000000Z",
            "updated_at": "2024-03-13T10:11:14.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "assigned_to_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "project_name": "OVC",
            "activity_name": "training"
        },
        {
            "id": 1,
            "assigned_to": 4,
            "created_by": 4,
            "organization_id": 12,
            "project_id": 1,
            "activity_id": 1,
            "status": "done",
            "title": "training",
            "description": "refge4bghufgbuhk",
            "start_date": "2024-03-05",
            "end_date": "2024-03-06",
            "number_of_days": 2,
            "created_at": "2024-03-05T11:21:55.000000Z",
            "updated_at": "2024-03-13T10:11:14.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "assigned_to_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera"
            },
            "project_name": "OVC",
            "activity_name": "training"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

PUT api/tasks/{id}

PATCH api/tasks/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Task Example: 18

Body Parameters

created_by   integer  optional  

The id of an existing record in the users table. Example: 3

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 19

project_id   integer  optional  

The id of an existing record in the projects table. Example: 8

activity_id   integer  optional  

The id of an existing record in the activities table. Example: 11

title   string  optional  

Example: et

description   string  optional  

Example: Labore quo esse nesciunt enim aspernatur pariatur inventore.

type   string  optional  

Example: multiple

Must be one of:
  • single
  • multiple
assigned_to   integer  optional  

The id of an existing record in the users table. Example: 5

status   string  optional  

Example: quasi

start_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

Remove the specified Task.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/tasks/10" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/tasks/10"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/tasks/10';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/tasks/10'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request      

DELETE api/tasks/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Task Example: 10

Get a logged in user list of assigned Tasks.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_assigned_tasks?per_page=18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/get_assigned_tasks"
);

const params = {
    "per_page": "18",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_assigned_tasks';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '18',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_assigned_tasks'
params = {
  'per_page': '18',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_assigned_tasks could not be found."
}
 

Request      

GET api/get_assigned_tasks

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 18

Get Tasks Gantt Chat.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/task_gantt_chat" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_id\": 3,
    \"start_date\": \"2026-01-25T16:32:31\",
    \"end_date\": \"2026-01-25T16:32:31\"
}"
const url = new URL(
    "https://api.cithar.com/api/task_gantt_chat"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "project_id": 3,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/task_gantt_chat';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'project_id' => 3,
            'start_date' => '2026-01-25T16:32:31',
            'end_date' => '2026-01-25T16:32:31',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/task_gantt_chat'
payload = {
    "project_id": 3,
    "start_date": "2026-01-25T16:32:31",
    "end_date": "2026-01-25T16:32:31"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/task_gantt_chat could not be found."
}
 

Request      

GET api/task_gantt_chat

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

project_id   integer   

The id of an existing record in the projects table. Example: 3

start_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

end_date   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

TimeSheet Endpoints

Display a listing of TimeSheet.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/time_sheets?per_page=6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/time_sheets"
);

const params = {
    "per_page": "6",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/time_sheets';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '6',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/time_sheets'
params = {
  'per_page': '6',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "created_by": 4,
            "organization_id": 12,
            "date": "2024-03",
            "details": {
                "tasks": [
                    {
                        "id": 1,
                        "title": "training",
                        "status": "pending",
                        "end_date": "2024-03-06",
                        "project_id": 1,
                        "start_date": "2024-03-05",
                        "activity_id": 1,
                        "description": "refge4bg",
                        "number_of_days": 2,
                        "individual_days": [
                            {
                                "day": "Tuesday",
                                "date": "2024-03-05",
                                "work_hour": 0
                            },
                            {
                                "day": "Wednesday",
                                "date": "2024-03-06",
                                "work_hour": 0
                            }
                        ]
                    }
                ],
                "leave_days": [],
                "holiday_days": [
                    "2024-03-07",
                    "2024-03-08"
                ],
                "timesheet_summary": {
                    "total_holidays": 1,
                    "total_work_days": 6,
                    "total_leave_days": 0,
                    "total_work_hours": 0
                },
                "user_project_details": [
                    {
                        "user_loe": 50,
                        "project_id": 1,
                        "project_name": "Erin Reyes"
                    }
                ]
            },
            "created_at": "2024-03-05T11:54:20.000000Z",
            "updated_at": "2024-03-05T11:54:20.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera",
                "designation": "it officer"
            },
            "timesheet_date_range": [
                {
                    "date": "2024-02-01",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-02",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-03",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-04",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-05",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-06",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-07",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-08",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-09",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-10",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-11",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-12",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-13",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-14",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-15",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-16",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-17",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-18",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-19",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-20",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-21",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-22",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-23",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-24",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-25",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-26",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-27",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-28",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-29",
                    "day": "Thu"
                }
            ],
            "timesheet_summary": {
                "total_work_hours": 0,
                "total_leave_days": 0,
                "total_holidays": 0
            },
            "approval_details": {
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "ghfvjhm",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:54:42.910077Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "current_approver_role": "hr level 1",
                "rejected_details": null,
                "status_tracker": null,
                "status": "pending"
            }
        },
        {
            "id": 1,
            "created_by": 4,
            "organization_id": 12,
            "date": "2024-03",
            "details": {
                "tasks": [
                    {
                        "id": 1,
                        "title": "training",
                        "status": "pending",
                        "end_date": "2024-03-06",
                        "project_id": 1,
                        "start_date": "2024-03-05",
                        "activity_id": 1,
                        "description": "refge4bg",
                        "number_of_days": 2,
                        "individual_days": [
                            {
                                "day": "Tuesday",
                                "date": "2024-03-05",
                                "work_hour": 0
                            },
                            {
                                "day": "Wednesday",
                                "date": "2024-03-06",
                                "work_hour": 0
                            }
                        ]
                    }
                ],
                "leave_days": [],
                "holiday_days": [
                    "2024-03-07",
                    "2024-03-08"
                ],
                "timesheet_summary": {
                    "total_holidays": 1,
                    "total_work_days": 6,
                    "total_leave_days": 0,
                    "total_work_hours": 0
                },
                "user_project_details": [
                    {
                        "user_loe": 50,
                        "project_id": 1,
                        "project_name": "Erin Reyes"
                    }
                ]
            },
            "created_at": "2024-03-05T11:54:20.000000Z",
            "updated_at": "2024-03-05T11:54:20.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera",
                "designation": "it officer"
            },
            "timesheet_date_range": [
                {
                    "date": "2024-02-01",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-02",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-03",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-04",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-05",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-06",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-07",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-08",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-09",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-10",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-11",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-12",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-13",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-14",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-15",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-16",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-17",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-18",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-19",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-20",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-21",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-22",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-23",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-24",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-25",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-26",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-27",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-28",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-29",
                    "day": "Thu"
                }
            ],
            "timesheet_summary": {
                "total_work_hours": 0,
                "total_leave_days": 0,
                "total_holidays": 0
            },
            "approval_details": {
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "ghfvjhm",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:54:42.910077Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "current_approver_role": "hr level 1",
                "rejected_details": null,
                "status_tracker": null,
                "status": "pending"
            }
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/time_sheets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

per_page   integer  optional  

Items per page Example: 6

Store a newly created TimeSheet.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/time_sheets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 7,
    \"organization_id\": 12,
    \"approver\": 10,
    \"approver_role\": \"neque\",
    \"date\": \"ut\",
    \"details\": []
}"
const url = new URL(
    "https://api.cithar.com/api/time_sheets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 7,
    "organization_id": 12,
    "approver": 10,
    "approver_role": "neque",
    "date": "ut",
    "details": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/time_sheets';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 7,
            'organization_id' => 12,
            'approver' => 10,
            'approver_role' => 'neque',
            'date' => 'ut',
            'details' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/time_sheets'
payload = {
    "created_by": 7,
    "organization_id": 12,
    "approver": 10,
    "approver_role": "neque",
    "date": "ut",
    "details": []
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "created_by": 4,
            "organization_id": 12,
            "date": "2024-03",
            "details": {
                "tasks": [
                    {
                        "id": 1,
                        "title": "training",
                        "status": "pending",
                        "end_date": "2024-03-06",
                        "project_id": 1,
                        "start_date": "2024-03-05",
                        "activity_id": 1,
                        "description": "refge4bg",
                        "number_of_days": 2,
                        "individual_days": [
                            {
                                "day": "Tuesday",
                                "date": "2024-03-05",
                                "work_hour": 0
                            },
                            {
                                "day": "Wednesday",
                                "date": "2024-03-06",
                                "work_hour": 0
                            }
                        ]
                    }
                ],
                "leave_days": [],
                "holiday_days": [
                    "2024-03-07",
                    "2024-03-08"
                ],
                "timesheet_summary": {
                    "total_holidays": 1,
                    "total_work_days": 6,
                    "total_leave_days": 0,
                    "total_work_hours": 0
                },
                "user_project_details": [
                    {
                        "user_loe": 50,
                        "project_id": 1,
                        "project_name": "Erin Reyes"
                    }
                ]
            },
            "created_at": "2024-03-05T11:54:20.000000Z",
            "updated_at": "2024-03-05T11:54:20.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera",
                "designation": "it officer"
            },
            "timesheet_date_range": [
                {
                    "date": "2024-02-01",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-02",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-03",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-04",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-05",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-06",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-07",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-08",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-09",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-10",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-11",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-12",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-13",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-14",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-15",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-16",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-17",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-18",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-19",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-20",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-21",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-22",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-23",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-24",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-25",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-26",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-27",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-28",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-29",
                    "day": "Thu"
                }
            ],
            "timesheet_summary": {
                "total_work_hours": 0,
                "total_leave_days": 0,
                "total_holidays": 0
            },
            "approval_details": {
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "ghfvjhm",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:54:42.910077Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "current_approver_role": "hr level 1",
                "rejected_details": null,
                "status_tracker": null,
                "status": "pending"
            }
        },
        {
            "id": 1,
            "created_by": 4,
            "organization_id": 12,
            "date": "2024-03",
            "details": {
                "tasks": [
                    {
                        "id": 1,
                        "title": "training",
                        "status": "pending",
                        "end_date": "2024-03-06",
                        "project_id": 1,
                        "start_date": "2024-03-05",
                        "activity_id": 1,
                        "description": "refge4bg",
                        "number_of_days": 2,
                        "individual_days": [
                            {
                                "day": "Tuesday",
                                "date": "2024-03-05",
                                "work_hour": 0
                            },
                            {
                                "day": "Wednesday",
                                "date": "2024-03-06",
                                "work_hour": 0
                            }
                        ]
                    }
                ],
                "leave_days": [],
                "holiday_days": [
                    "2024-03-07",
                    "2024-03-08"
                ],
                "timesheet_summary": {
                    "total_holidays": 1,
                    "total_work_days": 6,
                    "total_leave_days": 0,
                    "total_work_hours": 0
                },
                "user_project_details": [
                    {
                        "user_loe": 50,
                        "project_id": 1,
                        "project_name": "Erin Reyes"
                    }
                ]
            },
            "created_at": "2024-03-05T11:54:20.000000Z",
            "updated_at": "2024-03-05T11:54:20.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera",
                "designation": "it officer"
            },
            "timesheet_date_range": [
                {
                    "date": "2024-02-01",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-02",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-03",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-04",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-05",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-06",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-07",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-08",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-09",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-10",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-11",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-12",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-13",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-14",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-15",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-16",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-17",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-18",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-19",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-20",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-21",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-22",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-23",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-24",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-25",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-26",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-27",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-28",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-29",
                    "day": "Thu"
                }
            ],
            "timesheet_summary": {
                "total_work_hours": 0,
                "total_leave_days": 0,
                "total_holidays": 0
            },
            "approval_details": {
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "ghfvjhm",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:54:42.910077Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "current_approver_role": "hr level 1",
                "rejected_details": null,
                "status_tracker": null,
                "status": "pending"
            }
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

POST api/time_sheets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

created_by   integer   

The id of an existing record in the users table. Example: 7

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 12

approver   integer   

The id of an existing record in the users table. Example: 10

approver_role   string   

The name of an existing record in the roles table. Example: neque

date   string   

Example: ut

details   object   

Show the specified TimeSheet.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/time_sheets/eos" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/time_sheets/eos"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/time_sheets/eos';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/time_sheets/eos'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "created_by": 4,
            "organization_id": 12,
            "date": "2024-03",
            "details": {
                "tasks": [
                    {
                        "id": 1,
                        "title": "training",
                        "status": "pending",
                        "end_date": "2024-03-06",
                        "project_id": 1,
                        "start_date": "2024-03-05",
                        "activity_id": 1,
                        "description": "refge4bg",
                        "number_of_days": 2,
                        "individual_days": [
                            {
                                "day": "Tuesday",
                                "date": "2024-03-05",
                                "work_hour": 0
                            },
                            {
                                "day": "Wednesday",
                                "date": "2024-03-06",
                                "work_hour": 0
                            }
                        ]
                    }
                ],
                "leave_days": [],
                "holiday_days": [
                    "2024-03-07",
                    "2024-03-08"
                ],
                "timesheet_summary": {
                    "total_holidays": 1,
                    "total_work_days": 6,
                    "total_leave_days": 0,
                    "total_work_hours": 0
                },
                "user_project_details": [
                    {
                        "user_loe": 50,
                        "project_id": 1,
                        "project_name": "Erin Reyes"
                    }
                ]
            },
            "created_at": "2024-03-05T11:54:20.000000Z",
            "updated_at": "2024-03-05T11:54:20.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera",
                "designation": "it officer"
            },
            "timesheet_date_range": [
                {
                    "date": "2024-02-01",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-02",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-03",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-04",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-05",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-06",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-07",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-08",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-09",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-10",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-11",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-12",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-13",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-14",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-15",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-16",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-17",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-18",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-19",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-20",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-21",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-22",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-23",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-24",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-25",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-26",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-27",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-28",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-29",
                    "day": "Thu"
                }
            ],
            "timesheet_summary": {
                "total_work_hours": 0,
                "total_leave_days": 0,
                "total_holidays": 0
            },
            "approval_details": {
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "ghfvjhm",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:54:42.910077Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "current_approver_role": "hr level 1",
                "rejected_details": null,
                "status_tracker": null,
                "status": "pending"
            }
        },
        {
            "id": 1,
            "created_by": 4,
            "organization_id": 12,
            "date": "2024-03",
            "details": {
                "tasks": [
                    {
                        "id": 1,
                        "title": "training",
                        "status": "pending",
                        "end_date": "2024-03-06",
                        "project_id": 1,
                        "start_date": "2024-03-05",
                        "activity_id": 1,
                        "description": "refge4bg",
                        "number_of_days": 2,
                        "individual_days": [
                            {
                                "day": "Tuesday",
                                "date": "2024-03-05",
                                "work_hour": 0
                            },
                            {
                                "day": "Wednesday",
                                "date": "2024-03-06",
                                "work_hour": 0
                            }
                        ]
                    }
                ],
                "leave_days": [],
                "holiday_days": [
                    "2024-03-07",
                    "2024-03-08"
                ],
                "timesheet_summary": {
                    "total_holidays": 1,
                    "total_work_days": 6,
                    "total_leave_days": 0,
                    "total_work_hours": 0
                },
                "user_project_details": [
                    {
                        "user_loe": 50,
                        "project_id": 1,
                        "project_name": "Erin Reyes"
                    }
                ]
            },
            "created_at": "2024-03-05T11:54:20.000000Z",
            "updated_at": "2024-03-05T11:54:20.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera",
                "designation": "it officer"
            },
            "timesheet_date_range": [
                {
                    "date": "2024-02-01",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-02",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-03",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-04",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-05",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-06",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-07",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-08",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-09",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-10",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-11",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-12",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-13",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-14",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-15",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-16",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-17",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-18",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-19",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-20",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-21",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-22",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-23",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-24",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-25",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-26",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-27",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-28",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-29",
                    "day": "Thu"
                }
            ],
            "timesheet_summary": {
                "total_work_hours": 0,
                "total_leave_days": 0,
                "total_holidays": 0
            },
            "approval_details": {
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "ghfvjhm",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:54:42.910077Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "current_approver_role": "hr level 1",
                "rejected_details": null,
                "status_tracker": null,
                "status": "pending"
            }
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/time_sheets/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the time sheet. Example: eos

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/time_sheets/aut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 1,
    \"organization_id\": 18,
    \"approver\": 20,
    \"approver_role\": \"enim\",
    \"date\": \"fugit\"
}"
const url = new URL(
    "https://api.cithar.com/api/time_sheets/aut"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "created_by": 1,
    "organization_id": 18,
    "approver": 20,
    "approver_role": "enim",
    "date": "fugit"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/time_sheets/aut';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 1,
            'organization_id' => 18,
            'approver' => 20,
            'approver_role' => 'enim',
            'date' => 'fugit',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/time_sheets/aut'
payload = {
    "created_by": 1,
    "organization_id": 18,
    "approver": 20,
    "approver_role": "enim",
    "date": "fugit"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "created_by": 4,
            "organization_id": 12,
            "date": "2024-03",
            "details": {
                "tasks": [
                    {
                        "id": 1,
                        "title": "training",
                        "status": "pending",
                        "end_date": "2024-03-06",
                        "project_id": 1,
                        "start_date": "2024-03-05",
                        "activity_id": 1,
                        "description": "refge4bg",
                        "number_of_days": 2,
                        "individual_days": [
                            {
                                "day": "Tuesday",
                                "date": "2024-03-05",
                                "work_hour": 0
                            },
                            {
                                "day": "Wednesday",
                                "date": "2024-03-06",
                                "work_hour": 0
                            }
                        ]
                    }
                ],
                "leave_days": [],
                "holiday_days": [
                    "2024-03-07",
                    "2024-03-08"
                ],
                "timesheet_summary": {
                    "total_holidays": 1,
                    "total_work_days": 6,
                    "total_leave_days": 0,
                    "total_work_hours": 0
                },
                "user_project_details": [
                    {
                        "user_loe": 50,
                        "project_id": 1,
                        "project_name": "Erin Reyes"
                    }
                ]
            },
            "created_at": "2024-03-05T11:54:20.000000Z",
            "updated_at": "2024-03-05T11:54:20.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera",
                "designation": "it officer"
            },
            "timesheet_date_range": [
                {
                    "date": "2024-02-01",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-02",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-03",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-04",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-05",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-06",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-07",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-08",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-09",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-10",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-11",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-12",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-13",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-14",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-15",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-16",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-17",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-18",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-19",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-20",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-21",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-22",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-23",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-24",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-25",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-26",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-27",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-28",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-29",
                    "day": "Thu"
                }
            ],
            "timesheet_summary": {
                "total_work_hours": 0,
                "total_leave_days": 0,
                "total_holidays": 0
            },
            "approval_details": {
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "ghfvjhm",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:54:42.910077Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "current_approver_role": "hr level 1",
                "rejected_details": null,
                "status_tracker": null,
                "status": "pending"
            }
        },
        {
            "id": 1,
            "created_by": 4,
            "organization_id": 12,
            "date": "2024-03",
            "details": {
                "tasks": [
                    {
                        "id": 1,
                        "title": "training",
                        "status": "pending",
                        "end_date": "2024-03-06",
                        "project_id": 1,
                        "start_date": "2024-03-05",
                        "activity_id": 1,
                        "description": "refge4bg",
                        "number_of_days": 2,
                        "individual_days": [
                            {
                                "day": "Tuesday",
                                "date": "2024-03-05",
                                "work_hour": 0
                            },
                            {
                                "day": "Wednesday",
                                "date": "2024-03-06",
                                "work_hour": 0
                            }
                        ]
                    }
                ],
                "leave_days": [],
                "holiday_days": [
                    "2024-03-07",
                    "2024-03-08"
                ],
                "timesheet_summary": {
                    "total_holidays": 1,
                    "total_work_days": 6,
                    "total_leave_days": 0,
                    "total_work_hours": 0
                },
                "user_project_details": [
                    {
                        "user_loe": 50,
                        "project_id": 1,
                        "project_name": "Erin Reyes"
                    }
                ]
            },
            "created_at": "2024-03-05T11:54:20.000000Z",
            "updated_at": "2024-03-05T11:54:20.000000Z",
            "deleted_at": null,
            "created_by_user": {
                "first_name": "ernest",
                "middle_name": "shed",
                "last_name": "chidera",
                "designation": "it officer"
            },
            "timesheet_date_range": [
                {
                    "date": "2024-02-01",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-02",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-03",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-04",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-05",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-06",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-07",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-08",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-09",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-10",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-11",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-12",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-13",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-14",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-15",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-16",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-17",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-18",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-19",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-20",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-21",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-22",
                    "day": "Thu"
                },
                {
                    "date": "2024-02-23",
                    "day": "Fri"
                },
                {
                    "date": "2024-02-24",
                    "day": "Sat"
                },
                {
                    "date": "2024-02-25",
                    "day": "Sun"
                },
                {
                    "date": "2024-02-26",
                    "day": "Mon"
                },
                {
                    "date": "2024-02-27",
                    "day": "Tue"
                },
                {
                    "date": "2024-02-28",
                    "day": "Wed"
                },
                {
                    "date": "2024-02-29",
                    "day": "Thu"
                }
            ],
            "timesheet_summary": {
                "total_work_hours": 0,
                "total_leave_days": 0,
                "total_holidays": 0
            },
            "approval_details": {
                "current_approver_full_name": [
                    {
                        "first_name": "ernest",
                        "middle_name": "shed",
                        "last_name": "chidera"
                    }
                ],
                "approved_details": [
                    {
                        "remark": "ghfvjhm",
                        "user_id": 4,
                        "signature": null,
                        "approved_date": "2024-03-05T10:54:42.910077Z",
                        "user_full_name": {
                            "last_name": "Mayer",
                            "first_name": "Ray",
                            "middle_name": "Macon Sexton"
                        }
                    }
                ],
                "current_approver_role": "hr level 1",
                "rejected_details": null,
                "status_tracker": null,
                "status": "pending"
            }
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

PUT api/time_sheets/{id}

PATCH api/time_sheets/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the time sheet. Example: aut

Body Parameters

created_by   integer  optional  

The id of an existing record in the users table. Example: 1

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 18

approver   integer  optional  

The id of an existing record in the users table. Example: 20

approver_role   string  optional  

The name of an existing record in the roles table. Example: enim

date   string  optional  

Example: fugit

details   object  optional  

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/time_sheets/perspiciatis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/time_sheets/perspiciatis"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/time_sheets/perspiciatis';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/time_sheets/perspiciatis'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request      

DELETE api/time_sheets/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the time sheet. Example: perspiciatis

Get a logged-in user list of TimeSheets.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_user_time_sheets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/get_user_time_sheets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_user_time_sheets';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_user_time_sheets'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_user_time_sheets could not be found."
}
 

Request      

GET api/get_user_time_sheets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get a logged-in user timesheet report details.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_time_sheet_report_details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"timesheet_date\": \"dolores\"
}"
const url = new URL(
    "https://api.cithar.com/api/get_time_sheet_report_details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "timesheet_date": "dolores"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_time_sheet_report_details';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'timesheet_date' => 'dolores',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_time_sheet_report_details'
payload = {
    "timesheet_date": "dolores"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_time_sheet_report_details could not be found."
}
 

Request      

GET api/get_time_sheet_report_details

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

timesheet_date   string   

Example: dolores

User Details Endpoints

GET api/pass/{password}

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/pass/doA@-zD~|;`>=oFZ}-8" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/pass/doA@-zD~|;`>=oFZ}-8"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/pass/doA@-zD~|;`>=oFZ}-8';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/pass/doA@-zD~|;`>=oFZ}-8'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/pass/doA@-zD~|;`>=oFZ}-8 could not be found."
}
 

Request      

GET api/pass/{password}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

password   string   

Example: doA@-zD~|;>=oFZ}-8`

Display a listing of the User Details for admin roles.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/user_details?first_name=in&middle_name=quasi&last_name=rem&per_page=soluta&user_id=14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/user_details"
);

const params = {
    "first_name": "in",
    "middle_name": "quasi",
    "last_name": "rem",
    "per_page": "soluta",
    "user_id": "14",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/user_details';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'first_name' => 'in',
            'middle_name' => 'quasi',
            'last_name' => 'rem',
            'per_page' => 'soluta',
            'user_id' => '14',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/user_details'
params = {
  'first_name': 'in',
  'middle_name': 'quasi',
  'last_name': 'rem',
  'per_page': 'soluta',
  'user_id': '14',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "organization_id": null,
            "title": null,
            "first_name": "Super",
            "middle_name": null,
            "last_name": "Admin",
            "phone": null,
            "state_of_origin": "Enugu",
            "lga": null,
            "government_id_type": null,
            "government_id_number": null,
            "marital_status": null,
            "bank_name": null,
            "account_name": null,
            "account_number": null,
            "next_of_kin_full_name": null,
            "staff_id": null,
            "designation": "super admin",
            "next_of_kin_phone": null,
            "emergency_contact_name": null,
            "emergency_contact_phone": null,
            "emergency_contact_address": null,
            "avatar": null,
            "residential_address": "cithar",
            "signature": null,
            "dob": null,
            "gender": null,
            "otp": null,
            "created_at": null,
            "updated_at": "2024-03-11T10:16:52.000000Z",
            "deleted_at": null,
            "personal_email": "",
            "email": "superadmin@cithar.com",
            "roles": [
                {
                    "id": 1,
                    "name": "super admin"
                }
            ]
        },
        {
            "id": 1,
            "user_id": 1,
            "organization_id": null,
            "title": null,
            "first_name": "Super",
            "middle_name": null,
            "last_name": "Admin",
            "phone": null,
            "state_of_origin": "Enugu",
            "lga": null,
            "government_id_type": null,
            "government_id_number": null,
            "marital_status": null,
            "bank_name": null,
            "account_name": null,
            "account_number": null,
            "next_of_kin_full_name": null,
            "staff_id": null,
            "designation": "super admin",
            "next_of_kin_phone": null,
            "emergency_contact_name": null,
            "emergency_contact_phone": null,
            "emergency_contact_address": null,
            "avatar": null,
            "residential_address": "cithar",
            "signature": null,
            "dob": null,
            "gender": null,
            "otp": null,
            "created_at": null,
            "updated_at": "2024-03-11T10:16:52.000000Z",
            "deleted_at": null,
            "personal_email": "",
            "email": "superadmin@cithar.com",
            "roles": [
                {
                    "id": 1,
                    "name": "super admin"
                }
            ]
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/user_details

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

first_name   string  optional  

Search query parameter for first name Example: in

middle_name   string  optional  

Search query parameter for middle name Example: quasi

last_name   string  optional  

Search query parameter for last name Example: rem

per_page   string  optional  

Items per page Example: soluta

user_id   integer  optional  

to get specific user details, when user has role to view all data in the organization Example: 14

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/user_details/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/user_details/20"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/user_details/20';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/user_details/20'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "organization_id": null,
            "title": null,
            "first_name": "Super",
            "middle_name": null,
            "last_name": "Admin",
            "phone": null,
            "state_of_origin": "Enugu",
            "lga": null,
            "government_id_type": null,
            "government_id_number": null,
            "marital_status": null,
            "bank_name": null,
            "account_name": null,
            "account_number": null,
            "next_of_kin_full_name": null,
            "staff_id": null,
            "designation": "super admin",
            "next_of_kin_phone": null,
            "emergency_contact_name": null,
            "emergency_contact_phone": null,
            "emergency_contact_address": null,
            "avatar": null,
            "residential_address": "cithar",
            "signature": null,
            "dob": null,
            "gender": null,
            "otp": null,
            "created_at": null,
            "updated_at": "2024-03-11T10:16:52.000000Z",
            "deleted_at": null,
            "personal_email": "",
            "email": "superadmin@cithar.com",
            "roles": [
                {
                    "id": 1,
                    "name": "super admin"
                }
            ]
        },
        {
            "id": 1,
            "user_id": 1,
            "organization_id": null,
            "title": null,
            "first_name": "Super",
            "middle_name": null,
            "last_name": "Admin",
            "phone": null,
            "state_of_origin": "Enugu",
            "lga": null,
            "government_id_type": null,
            "government_id_number": null,
            "marital_status": null,
            "bank_name": null,
            "account_name": null,
            "account_number": null,
            "next_of_kin_full_name": null,
            "staff_id": null,
            "designation": "super admin",
            "next_of_kin_phone": null,
            "emergency_contact_name": null,
            "emergency_contact_phone": null,
            "emergency_contact_address": null,
            "avatar": null,
            "residential_address": "cithar",
            "signature": null,
            "dob": null,
            "gender": null,
            "otp": null,
            "created_at": null,
            "updated_at": "2024-03-11T10:16:52.000000Z",
            "deleted_at": null,
            "personal_email": "",
            "email": "superadmin@cithar.com",
            "roles": [
                {
                    "id": 1,
                    "name": "super admin"
                }
            ]
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/user_details/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the Asset Example: 20

Update the specified User details for admin roles.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/user_details/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 5,
    \"title\": \"ut\",
    \"first_name\": \"aut\",
    \"middle_name\": \"sint\",
    \"last_name\": \"sapiente\",
    \"phone\": \"dolor\",
    \"personal_email\": \"rblick@example.com\",
    \"state_of_origin\": \"nulla\",
    \"lga\": \"nisi\",
    \"government_id_type\": \"qui\",
    \"government_id_number\": \"adipisci\",
    \"marital_status\": \"rem\",
    \"bank_name\": \"nostrum\",
    \"account_name\": \"vel\",
    \"account_number\": \"pariatur\",
    \"next_of_kin_full_name\": \"autem\",
    \"next_of_kin_phone\": \"consequuntur\",
    \"emergency_contact_name\": \"et\",
    \"emergency_contact_phone\": \"fugit\",
    \"emergency_contact_address\": \"illo\",
    \"staff_id\": \"harum\",
    \"residential_address\": \"qui\",
    \"dob\": \"2026-01-25T16:32:31\",
    \"gender\": \"error\",
    \"designation\": \"quisquam\",
    \"signature\": \"quae\",
    \"otp\": \"eos\",
    \"roles\": [
        \"atque\"
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/user_details/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 5,
    "title": "ut",
    "first_name": "aut",
    "middle_name": "sint",
    "last_name": "sapiente",
    "phone": "dolor",
    "personal_email": "rblick@example.com",
    "state_of_origin": "nulla",
    "lga": "nisi",
    "government_id_type": "qui",
    "government_id_number": "adipisci",
    "marital_status": "rem",
    "bank_name": "nostrum",
    "account_name": "vel",
    "account_number": "pariatur",
    "next_of_kin_full_name": "autem",
    "next_of_kin_phone": "consequuntur",
    "emergency_contact_name": "et",
    "emergency_contact_phone": "fugit",
    "emergency_contact_address": "illo",
    "staff_id": "harum",
    "residential_address": "qui",
    "dob": "2026-01-25T16:32:31",
    "gender": "error",
    "designation": "quisquam",
    "signature": "quae",
    "otp": "eos",
    "roles": [
        "atque"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/user_details/17';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'organization_id' => 5,
            'title' => 'ut',
            'first_name' => 'aut',
            'middle_name' => 'sint',
            'last_name' => 'sapiente',
            'phone' => 'dolor',
            'personal_email' => 'rblick@example.com',
            'state_of_origin' => 'nulla',
            'lga' => 'nisi',
            'government_id_type' => 'qui',
            'government_id_number' => 'adipisci',
            'marital_status' => 'rem',
            'bank_name' => 'nostrum',
            'account_name' => 'vel',
            'account_number' => 'pariatur',
            'next_of_kin_full_name' => 'autem',
            'next_of_kin_phone' => 'consequuntur',
            'emergency_contact_name' => 'et',
            'emergency_contact_phone' => 'fugit',
            'emergency_contact_address' => 'illo',
            'staff_id' => 'harum',
            'residential_address' => 'qui',
            'dob' => '2026-01-25T16:32:31',
            'gender' => 'error',
            'designation' => 'quisquam',
            'signature' => 'quae',
            'otp' => 'eos',
            'roles' => [
                'atque',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/user_details/17'
payload = {
    "organization_id": 5,
    "title": "ut",
    "first_name": "aut",
    "middle_name": "sint",
    "last_name": "sapiente",
    "phone": "dolor",
    "personal_email": "rblick@example.com",
    "state_of_origin": "nulla",
    "lga": "nisi",
    "government_id_type": "qui",
    "government_id_number": "adipisci",
    "marital_status": "rem",
    "bank_name": "nostrum",
    "account_name": "vel",
    "account_number": "pariatur",
    "next_of_kin_full_name": "autem",
    "next_of_kin_phone": "consequuntur",
    "emergency_contact_name": "et",
    "emergency_contact_phone": "fugit",
    "emergency_contact_address": "illo",
    "staff_id": "harum",
    "residential_address": "qui",
    "dob": "2026-01-25T16:32:31",
    "gender": "error",
    "designation": "quisquam",
    "signature": "quae",
    "otp": "eos",
    "roles": [
        "atque"
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "organization_id": null,
            "title": null,
            "first_name": "Super",
            "middle_name": null,
            "last_name": "Admin",
            "phone": null,
            "state_of_origin": "Enugu",
            "lga": null,
            "government_id_type": null,
            "government_id_number": null,
            "marital_status": null,
            "bank_name": null,
            "account_name": null,
            "account_number": null,
            "next_of_kin_full_name": null,
            "staff_id": null,
            "designation": "super admin",
            "next_of_kin_phone": null,
            "emergency_contact_name": null,
            "emergency_contact_phone": null,
            "emergency_contact_address": null,
            "avatar": null,
            "residential_address": "cithar",
            "signature": null,
            "dob": null,
            "gender": null,
            "otp": null,
            "created_at": null,
            "updated_at": "2024-03-11T10:16:52.000000Z",
            "deleted_at": null,
            "personal_email": "",
            "email": "superadmin@cithar.com",
            "roles": [
                {
                    "id": 1,
                    "name": "super admin"
                }
            ]
        },
        {
            "id": 1,
            "user_id": 1,
            "organization_id": null,
            "title": null,
            "first_name": "Super",
            "middle_name": null,
            "last_name": "Admin",
            "phone": null,
            "state_of_origin": "Enugu",
            "lga": null,
            "government_id_type": null,
            "government_id_number": null,
            "marital_status": null,
            "bank_name": null,
            "account_name": null,
            "account_number": null,
            "next_of_kin_full_name": null,
            "staff_id": null,
            "designation": "super admin",
            "next_of_kin_phone": null,
            "emergency_contact_name": null,
            "emergency_contact_phone": null,
            "emergency_contact_address": null,
            "avatar": null,
            "residential_address": "cithar",
            "signature": null,
            "dob": null,
            "gender": null,
            "otp": null,
            "created_at": null,
            "updated_at": "2024-03-11T10:16:52.000000Z",
            "deleted_at": null,
            "personal_email": "",
            "email": "superadmin@cithar.com",
            "roles": [
                {
                    "id": 1,
                    "name": "super admin"
                }
            ]
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

PUT api/user_details/{id}

PATCH api/user_details/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the User Details Example: 17

Body Parameters

organization_id   integer  optional  

The id of an existing record in the organizations table. Example: 5

title   string  optional  

Example: ut

first_name   string  optional  

Example: aut

middle_name   string  optional  

Example: sint

last_name   string  optional  

Example: sapiente

phone   string  optional  

Example: dolor

personal_email   string  optional  

Must be a valid email address. Example: rblick@example.com

state_of_origin   string  optional  

Example: nulla

lga   string  optional  

Example: nisi

government_id_type   string  optional  

Example: qui

government_id_number   string  optional  

Example: adipisci

marital_status   string  optional  

Example: rem

bank_name   string  optional  

Example: nostrum

account_name   string  optional  

Example: vel

account_number   string  optional  

Example: pariatur

next_of_kin_full_name   string  optional  

Example: autem

next_of_kin_phone   string  optional  

Example: consequuntur

emergency_contact_name   string  optional  

Example: et

emergency_contact_phone   string  optional  

Example: fugit

emergency_contact_address   string  optional  

Example: illo

staff_id   string  optional  

Example: harum

avatar   string  optional  
residential_address   string  optional  

Example: qui

dob   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

gender   string  optional  

Example: error

designation   string  optional  

Example: quisquam

signature   string  optional  

Example: quae

otp   string  optional  

Example: eos

roles   string[]  optional  

The name of an existing record in the roles table.

Get logged in user profile.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/user"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/user';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/user'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "organization_id": null,
            "title": null,
            "first_name": "Super",
            "middle_name": null,
            "last_name": "Admin",
            "phone": null,
            "state_of_origin": "Enugu",
            "lga": null,
            "government_id_type": null,
            "government_id_number": null,
            "marital_status": null,
            "bank_name": null,
            "account_name": null,
            "account_number": null,
            "next_of_kin_full_name": null,
            "staff_id": null,
            "designation": "super admin",
            "next_of_kin_phone": null,
            "emergency_contact_name": null,
            "emergency_contact_phone": null,
            "emergency_contact_address": null,
            "avatar": null,
            "residential_address": "cithar",
            "signature": null,
            "dob": null,
            "gender": null,
            "otp": null,
            "created_at": null,
            "updated_at": "2024-03-11T10:16:52.000000Z",
            "deleted_at": null,
            "personal_email": "",
            "email": "superadmin@cithar.com",
            "roles": [
                {
                    "id": 1,
                    "name": "super admin"
                }
            ]
        },
        {
            "id": 1,
            "user_id": 1,
            "organization_id": null,
            "title": null,
            "first_name": "Super",
            "middle_name": null,
            "last_name": "Admin",
            "phone": null,
            "state_of_origin": "Enugu",
            "lga": null,
            "government_id_type": null,
            "government_id_number": null,
            "marital_status": null,
            "bank_name": null,
            "account_name": null,
            "account_number": null,
            "next_of_kin_full_name": null,
            "staff_id": null,
            "designation": "super admin",
            "next_of_kin_phone": null,
            "emergency_contact_name": null,
            "emergency_contact_phone": null,
            "emergency_contact_address": null,
            "avatar": null,
            "residential_address": "cithar",
            "signature": null,
            "dob": null,
            "gender": null,
            "otp": null,
            "created_at": null,
            "updated_at": "2024-03-11T10:16:52.000000Z",
            "deleted_at": null,
            "personal_email": "",
            "email": "superadmin@cithar.com",
            "roles": [
                {
                    "id": 1,
                    "name": "super admin"
                }
            ]
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/user

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Update a logged in user profile.

requires authentication

Example request:
curl --request PATCH \
    "https://api.cithar.com/api/user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"ad\",
    \"phone\": \"laudantium\",
    \"state_of_origin\": \"enim\",
    \"lga\": \"tempore\",
    \"government_id_type\": \"suscipit\",
    \"government_id_number\": \"dolorem\",
    \"marital_status\": \"at\",
    \"bank_name\": \"nihil\",
    \"account_name\": \"voluptate\",
    \"account_number\": \"laudantium\",
    \"next_of_kin_full_name\": \"dolore\",
    \"next_of_kin_phone\": \"provident\",
    \"emergency_contact_name\": \"tempore\",
    \"emergency_contact_phone\": \"aut\",
    \"emergency_contact_address\": \"non\",
    \"signature\": \"eum\",
    \"residential_address\": \"voluptatem\",
    \"dob\": \"2026-01-25T16:32:31\",
    \"gender\": \"officiis\",
    \"otp\": \"aliquam\"
}"
const url = new URL(
    "https://api.cithar.com/api/user"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "ad",
    "phone": "laudantium",
    "state_of_origin": "enim",
    "lga": "tempore",
    "government_id_type": "suscipit",
    "government_id_number": "dolorem",
    "marital_status": "at",
    "bank_name": "nihil",
    "account_name": "voluptate",
    "account_number": "laudantium",
    "next_of_kin_full_name": "dolore",
    "next_of_kin_phone": "provident",
    "emergency_contact_name": "tempore",
    "emergency_contact_phone": "aut",
    "emergency_contact_address": "non",
    "signature": "eum",
    "residential_address": "voluptatem",
    "dob": "2026-01-25T16:32:31",
    "gender": "officiis",
    "otp": "aliquam"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/user';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'ad',
            'phone' => 'laudantium',
            'state_of_origin' => 'enim',
            'lga' => 'tempore',
            'government_id_type' => 'suscipit',
            'government_id_number' => 'dolorem',
            'marital_status' => 'at',
            'bank_name' => 'nihil',
            'account_name' => 'voluptate',
            'account_number' => 'laudantium',
            'next_of_kin_full_name' => 'dolore',
            'next_of_kin_phone' => 'provident',
            'emergency_contact_name' => 'tempore',
            'emergency_contact_phone' => 'aut',
            'emergency_contact_address' => 'non',
            'signature' => 'eum',
            'residential_address' => 'voluptatem',
            'dob' => '2026-01-25T16:32:31',
            'gender' => 'officiis',
            'otp' => 'aliquam',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/user'
payload = {
    "title": "ad",
    "phone": "laudantium",
    "state_of_origin": "enim",
    "lga": "tempore",
    "government_id_type": "suscipit",
    "government_id_number": "dolorem",
    "marital_status": "at",
    "bank_name": "nihil",
    "account_name": "voluptate",
    "account_number": "laudantium",
    "next_of_kin_full_name": "dolore",
    "next_of_kin_phone": "provident",
    "emergency_contact_name": "tempore",
    "emergency_contact_phone": "aut",
    "emergency_contact_address": "non",
    "signature": "eum",
    "residential_address": "voluptatem",
    "dob": "2026-01-25T16:32:31",
    "gender": "officiis",
    "otp": "aliquam"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()

Example response (200):


{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "organization_id": null,
            "title": null,
            "first_name": "Super",
            "middle_name": null,
            "last_name": "Admin",
            "phone": null,
            "state_of_origin": "Enugu",
            "lga": null,
            "government_id_type": null,
            "government_id_number": null,
            "marital_status": null,
            "bank_name": null,
            "account_name": null,
            "account_number": null,
            "next_of_kin_full_name": null,
            "staff_id": null,
            "designation": "super admin",
            "next_of_kin_phone": null,
            "emergency_contact_name": null,
            "emergency_contact_phone": null,
            "emergency_contact_address": null,
            "avatar": null,
            "residential_address": "cithar",
            "signature": null,
            "dob": null,
            "gender": null,
            "otp": null,
            "created_at": null,
            "updated_at": "2024-03-11T10:16:52.000000Z",
            "deleted_at": null,
            "personal_email": "",
            "email": "superadmin@cithar.com",
            "roles": [
                {
                    "id": 1,
                    "name": "super admin"
                }
            ]
        },
        {
            "id": 1,
            "user_id": 1,
            "organization_id": null,
            "title": null,
            "first_name": "Super",
            "middle_name": null,
            "last_name": "Admin",
            "phone": null,
            "state_of_origin": "Enugu",
            "lga": null,
            "government_id_type": null,
            "government_id_number": null,
            "marital_status": null,
            "bank_name": null,
            "account_name": null,
            "account_number": null,
            "next_of_kin_full_name": null,
            "staff_id": null,
            "designation": "super admin",
            "next_of_kin_phone": null,
            "emergency_contact_name": null,
            "emergency_contact_phone": null,
            "emergency_contact_address": null,
            "avatar": null,
            "residential_address": "cithar",
            "signature": null,
            "dob": null,
            "gender": null,
            "otp": null,
            "created_at": null,
            "updated_at": "2024-03-11T10:16:52.000000Z",
            "deleted_at": null,
            "personal_email": "",
            "email": "superadmin@cithar.com",
            "roles": [
                {
                    "id": 1,
                    "name": "super admin"
                }
            ]
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}
 

Request      

PATCH api/user

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string  optional  

Example: ad

phone   string  optional  

Example: laudantium

state_of_origin   string  optional  

Example: enim

lga   string  optional  

Example: tempore

government_id_type   string  optional  

Example: suscipit

government_id_number   string  optional  

Example: dolorem

marital_status   string  optional  

Example: at

bank_name   string  optional  

Example: nihil

account_name   string  optional  

Example: voluptate

account_number   string  optional  

Example: laudantium

next_of_kin_full_name   string  optional  

Example: dolore

next_of_kin_phone   string  optional  

Example: provident

emergency_contact_name   string  optional  

Example: tempore

emergency_contact_phone   string  optional  

Example: aut

emergency_contact_address   string  optional  

Example: non

signature   string  optional  

Example: eum

avatar   string  optional  
residential_address   string  optional  

Example: voluptatem

dob   string  optional  

Must be a valid date. Example: 2026-01-25T16:32:31

gender   string  optional  

Example: officiis

otp   string  optional  

Example: aliquam

Update a logged in user profile.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/get_all_users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.cithar.com/api/get_all_users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/get_all_users';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_all_users'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "The route api/get_all_users could not be found."
}
 

Request      

GET api/get_all_users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json