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=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"
);

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/approvals';
$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/approvals'
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": 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-05T10:19:03.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:19:02.000000Z",
                "updated_at": "2024-03-05T10: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-05T10:19:03.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:19:02.000000Z",
                "updated_at": "2024-03-05T10: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: 3

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/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/approvals/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/approvals/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/approvals/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,
            "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-05T10:19:03.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:19:02.000000Z",
                "updated_at": "2024-03-05T10: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-05T10:19:03.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:19:02.000000Z",
                "updated_at": "2024-03-05T10: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: 19

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\": \"leave\",
    \"per_page\": 8
}"
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": "leave",
    "per_page": 8
};

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' => 'leave',
            'per_page' => 8,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/get_approver'
payload = {
    "request_type": "leave",
    "per_page": 8
}
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: leave

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

Example: 8

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\": 12
}"
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": 12
};

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' => 12,
        ],
    ]
);
$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": 12
}
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: 12

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\": 14
}"
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": 14
};

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' => 14,
        ],
    ]
);
$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": 14
}
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: 14

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\": \"leave\",
    \"approver\": 18,
    \"approver_role\": \"quis\",
    \"previous_approver_role\": \"voluptatum\",
    \"status\": \"rejected\",
    \"remark\": \"et\",
    \"related_document\": \"et\",
    \"report_document\": \"aut\",
    \"request_model_id\": \"quidem\"
}"
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": "leave",
    "approver": 18,
    "approver_role": "quis",
    "previous_approver_role": "voluptatum",
    "status": "rejected",
    "remark": "et",
    "related_document": "et",
    "report_document": "aut",
    "request_model_id": "quidem"
};

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' => 'leave',
            'approver' => 18,
            'approver_role' => 'quis',
            'previous_approver_role' => 'voluptatum',
            'status' => 'rejected',
            'remark' => 'et',
            'related_document' => 'et',
            'report_document' => 'aut',
            'request_model_id' => 'quidem',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/approve_reject'
payload = {
    "request_type": "leave",
    "approver": 18,
    "approver_role": "quis",
    "previous_approver_role": "voluptatum",
    "status": "rejected",
    "remark": "et",
    "related_document": "et",
    "report_document": "aut",
    "request_model_id": "quidem"
}
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: leave

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

Example: 18

approver_role   string  optional  

This field is required when approver is present. Example: quis

previous_approver_role   string  optional  

Example: voluptatum

status   string  optional  

Example: rejected

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

Example: et

related_document   string  optional  

Example: et

report_document   string  optional  

Example: aut

request_model_id   string   

Example: quidem

Assets Endpoints

Display a listing of the Assets.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/assets?per_page=7&assigned_to=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/assets"
);

const params = {
    "per_page": "7",
    "assigned_to": "repellat",
};
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' => '7',
            'assigned_to' => 'repellat',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets'
params = {
  'per_page': '7',
  'assigned_to': 'repellat',
}
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-05T10:17:45.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:17:45.000000Z",
            "updated_at": "2024-03-05T10: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: 7

assigned_to   string  optional  

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

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\": 7,
    \"project_id\": 19,
    \"assigned_to\": 11,
    \"description\": \"Quibusdam animi et corporis eius amet velit.\",
    \"classification\": \"nam\",
    \"acquisition_date\": \"2025-01-26T17:33:45\",
    \"disposal_date\": \"2025-01-26T17:33:45\",
    \"disposal_value\": 4,
    \"acquisition_value\": 7,
    \"tag_name\": \"sit\",
    \"acquisition_value_local\": 15,
    \"fair_market_value\": 10,
    \"serial_number\": \"ut\",
    \"lpo_number\": \"ut\",
    \"invoice_number\": \"dolor\",
    \"model_number\": \"commodi\",
    \"vendor_name\": \"hic\",
    \"life_span\": \"rerum\",
    \"location_type\": \"est\",
    \"location_value\": \"repellendus\",
    \"condition\": \"sequi\",
    \"received_note\": \"quo\",
    \"disposal_approval_donor\": \"deleniti\",
    \"disposal_approval_board\": \"aspernatur\"
}"
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": 7,
    "project_id": 19,
    "assigned_to": 11,
    "description": "Quibusdam animi et corporis eius amet velit.",
    "classification": "nam",
    "acquisition_date": "2025-01-26T17:33:45",
    "disposal_date": "2025-01-26T17:33:45",
    "disposal_value": 4,
    "acquisition_value": 7,
    "tag_name": "sit",
    "acquisition_value_local": 15,
    "fair_market_value": 10,
    "serial_number": "ut",
    "lpo_number": "ut",
    "invoice_number": "dolor",
    "model_number": "commodi",
    "vendor_name": "hic",
    "life_span": "rerum",
    "location_type": "est",
    "location_value": "repellendus",
    "condition": "sequi",
    "received_note": "quo",
    "disposal_approval_donor": "deleniti",
    "disposal_approval_board": "aspernatur"
};

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' => 7,
            'project_id' => 19,
            'assigned_to' => 11,
            'description' => 'Quibusdam animi et corporis eius amet velit.',
            'classification' => 'nam',
            'acquisition_date' => '2025-01-26T17:33:45',
            'disposal_date' => '2025-01-26T17:33:45',
            'disposal_value' => 4,
            'acquisition_value' => 7,
            'tag_name' => 'sit',
            'acquisition_value_local' => 15,
            'fair_market_value' => 10,
            'serial_number' => 'ut',
            'lpo_number' => 'ut',
            'invoice_number' => 'dolor',
            'model_number' => 'commodi',
            'vendor_name' => 'hic',
            'life_span' => 'rerum',
            'location_type' => 'est',
            'location_value' => 'repellendus',
            'condition' => 'sequi',
            'received_note' => 'quo',
            'disposal_approval_donor' => 'deleniti',
            'disposal_approval_board' => 'aspernatur',
        ],
    ]
);
$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": 7,
    "project_id": 19,
    "assigned_to": 11,
    "description": "Quibusdam animi et corporis eius amet velit.",
    "classification": "nam",
    "acquisition_date": "2025-01-26T17:33:45",
    "disposal_date": "2025-01-26T17:33:45",
    "disposal_value": 4,
    "acquisition_value": 7,
    "tag_name": "sit",
    "acquisition_value_local": 15,
    "fair_market_value": 10,
    "serial_number": "ut",
    "lpo_number": "ut",
    "invoice_number": "dolor",
    "model_number": "commodi",
    "vendor_name": "hic",
    "life_span": "rerum",
    "location_type": "est",
    "location_value": "repellendus",
    "condition": "sequi",
    "received_note": "quo",
    "disposal_approval_donor": "deleniti",
    "disposal_approval_board": "aspernatur"
}
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-05T10:17:45.000000Z",
        "updated_at": "2024-03-05T10: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   

Example: 10

organization_id   integer  optional  

Example: 7

project_id   integer  optional  

Example: 19

assigned_to   integer  optional  

Example: 11

description   string   

Example: Quibusdam animi et corporis eius amet velit.

classification   string   

Example: nam

acquisition_date   string   

Must be a valid date. Example: 2025-01-26T17:33:45

disposal_date   string   

Must be a valid date. Example: 2025-01-26T17:33:45

disposal_value   integer  optional  

Example: 4

acquisition_value   integer   

Example: 7

tag_name   string   

Example: sit

acquisition_value_local   integer  optional  

Example: 15

fair_market_value   integer  optional  

Example: 10

serial_number   string  optional  

Example: ut

lpo_number   string  optional  

Example: ut

invoice_number   string   

Example: dolor

model_number   string   

Example: commodi

vendor_name   string   

Example: hic

life_span   string   

Example: rerum

location_type   string  optional  

Example: est

location_value   string  optional  

Example: repellendus

condition   string   

Example: sequi

received_note   string  optional  

Example: quo

disposal_approval_donor   string  optional  

Example: deleniti

disposal_approval_board   string  optional  

Example: aspernatur

Show a specified Asset.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/assets/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/assets/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/assets/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/assets/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,
        "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-05T10:17:45.000000Z",
        "updated_at": "2024-03-05T10: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: 9

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\": 6,
    \"project_id\": 12,
    \"organization_id\": 7,
    \"description\": \"Error nisi quia ut.\",
    \"classification\": \"cum\",
    \"acquisition_date\": \"2025-01-26T17:33:45\",
    \"disposal_date\": \"2025-01-26T17:33:45\",
    \"disposal_value\": 17,
    \"acquisition_value\": 12,
    \"fair_market_value\": 14,
    \"serial_number\": \"beatae\",
    \"lpo_number\": \"ad\",
    \"tag_name\": \"omnis\",
    \"acquisition_value_local\": \"rerum\",
    \"invoice_number\": \"aut\",
    \"model_number\": \"iure\",
    \"vendor_name\": \"ut\",
    \"life_span\": \"maiores\",
    \"location_type\": \"eveniet\",
    \"location_value\": \"dignissimos\",
    \"condition\": \"illum\",
    \"received_note\": \"iste\",
    \"disposal_approval_donor\": \"et\",
    \"disposal_approval_board\": \"dolores\"
}"
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": 6,
    "project_id": 12,
    "organization_id": 7,
    "description": "Error nisi quia ut.",
    "classification": "cum",
    "acquisition_date": "2025-01-26T17:33:45",
    "disposal_date": "2025-01-26T17:33:45",
    "disposal_value": 17,
    "acquisition_value": 12,
    "fair_market_value": 14,
    "serial_number": "beatae",
    "lpo_number": "ad",
    "tag_name": "omnis",
    "acquisition_value_local": "rerum",
    "invoice_number": "aut",
    "model_number": "iure",
    "vendor_name": "ut",
    "life_span": "maiores",
    "location_type": "eveniet",
    "location_value": "dignissimos",
    "condition": "illum",
    "received_note": "iste",
    "disposal_approval_donor": "et",
    "disposal_approval_board": "dolores"
};

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' => 6,
            'project_id' => 12,
            'organization_id' => 7,
            'description' => 'Error nisi quia ut.',
            'classification' => 'cum',
            'acquisition_date' => '2025-01-26T17:33:45',
            'disposal_date' => '2025-01-26T17:33:45',
            'disposal_value' => 17,
            'acquisition_value' => 12,
            'fair_market_value' => 14,
            'serial_number' => 'beatae',
            'lpo_number' => 'ad',
            'tag_name' => 'omnis',
            'acquisition_value_local' => 'rerum',
            'invoice_number' => 'aut',
            'model_number' => 'iure',
            'vendor_name' => 'ut',
            'life_span' => 'maiores',
            'location_type' => 'eveniet',
            'location_value' => 'dignissimos',
            'condition' => 'illum',
            'received_note' => 'iste',
            'disposal_approval_donor' => 'et',
            'disposal_approval_board' => 'dolores',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets/18'
payload = {
    "assigned_to": 6,
    "project_id": 12,
    "organization_id": 7,
    "description": "Error nisi quia ut.",
    "classification": "cum",
    "acquisition_date": "2025-01-26T17:33:45",
    "disposal_date": "2025-01-26T17:33:45",
    "disposal_value": 17,
    "acquisition_value": 12,
    "fair_market_value": 14,
    "serial_number": "beatae",
    "lpo_number": "ad",
    "tag_name": "omnis",
    "acquisition_value_local": "rerum",
    "invoice_number": "aut",
    "model_number": "iure",
    "vendor_name": "ut",
    "life_span": "maiores",
    "location_type": "eveniet",
    "location_value": "dignissimos",
    "condition": "illum",
    "received_note": "iste",
    "disposal_approval_donor": "et",
    "disposal_approval_board": "dolores"
}
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-05T10:17:45.000000Z",
        "updated_at": "2024-03-05T10: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  

Example: 6

project_id   integer  optional  

Example: 12

organization_id   integer  optional  

Example: 7

description   string  optional  

Example: Error nisi quia ut.

classification   string  optional  

Example: cum

acquisition_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:45

disposal_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:45

disposal_value   integer  optional  

Example: 17

acquisition_value   integer  optional  

Example: 12

fair_market_value   integer  optional  

Example: 14

serial_number   string  optional  

Example: beatae

lpo_number   string  optional  

Example: ad

tag_name   string  optional  

Example: omnis

acquisition_value_local   string  optional  

Example: rerum

invoice_number   string  optional  

Example: aut

model_number   string  optional  

Example: iure

vendor_name   string  optional  

Example: ut

life_span   string  optional  

Example: maiores

location_type   string  optional  

Example: eveniet

location_value   string  optional  

Example: dignissimos

condition   string  optional  

Example: illum

received_note   string  optional  

Example: iste

disposal_approval_donor   string  optional  

Example: et

disposal_approval_board   string  optional  

Example: dolores

Remove the specified Asset.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/assets/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/assets/9"
);

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/9';
$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/9'
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: 9

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=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/get_user_asset"
);

const params = {
    "per_page": "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: "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' => '13',
        ],
    ]
);
$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': '13',
}
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: 13

Display a listing of the Assets Classifications.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/assets_classifications?term=mollitia&per_page=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/assets_classifications"
);

const params = {
    "term": "mollitia",
    "per_page": "9",
};
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' => 'mollitia',
            'per_page' => '9',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_classifications'
params = {
  'term': 'mollitia',
  'per_page': '9',
}
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-05T10:12:31.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:12:31.000000Z",
            "updated_at": "2024-03-05T10: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: mollitia

per_page   integer  optional  

Items per page Example: 9

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\": \"magnam\",
    \"description\": \"Placeat quis at nisi nesciunt dolore repellendus voluptatibus totam.\",
    \"organization_id\": 15,
    \"created_by\": 11
}"
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": "magnam",
    "description": "Placeat quis at nisi nesciunt dolore repellendus voluptatibus totam.",
    "organization_id": 15,
    "created_by": 11
};

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' => 'magnam',
            'description' => 'Placeat quis at nisi nesciunt dolore repellendus voluptatibus totam.',
            'organization_id' => 15,
            'created_by' => 11,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_classifications'
payload = {
    "name": "magnam",
    "description": "Placeat quis at nisi nesciunt dolore repellendus voluptatibus totam.",
    "organization_id": 15,
    "created_by": 11
}
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-05T10:12:31.000000Z",
        "updated_at": "2024-03-05T10: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: magnam

description   string  optional  

Example: Placeat quis at nisi nesciunt dolore repellendus voluptatibus totam.

organization_id   integer  optional  

Example: 15

created_by   integer   

Example: 11

Show the specified Assets Classification.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/assets_classifications/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/assets_classifications/4"
);

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/4';
$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/4'
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-05T10:12:31.000000Z",
        "updated_at": "2024-03-05T10: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: 4

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/assets_classifications/4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"sunt\",
    \"description\": \"Rerum laudantium autem saepe in aspernatur magnam vitae sequi.\",
    \"organization_id\": 17,
    \"created_by\": 16
}"
const url = new URL(
    "https://api.cithar.com/api/assets_classifications/4"
);

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

let body = {
    "name": "sunt",
    "description": "Rerum laudantium autem saepe in aspernatur magnam vitae sequi.",
    "organization_id": 17,
    "created_by": 16
};

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/4';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'sunt',
            'description' => 'Rerum laudantium autem saepe in aspernatur magnam vitae sequi.',
            'organization_id' => 17,
            'created_by' => 16,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_classifications/4'
payload = {
    "name": "sunt",
    "description": "Rerum laudantium autem saepe in aspernatur magnam vitae sequi.",
    "organization_id": 17,
    "created_by": 16
}
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-05T10:12:31.000000Z",
        "updated_at": "2024-03-05T10: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: 4

Body Parameters

name   string  optional  

Example: sunt

description   string  optional  

Example: Rerum laudantium autem saepe in aspernatur magnam vitae sequi.

organization_id   integer  optional  

Example: 17

created_by   integer  optional  

Example: 16

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/assets_classifications/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/assets_classifications/8"
);

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/8';
$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/8'
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-05T10:12:31.000000Z",
        "updated_at": "2024-03-05T10: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: 8

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\": 18,
    \"project_id\": 14,
    \"classification\": \"eum\",
    \"document\": \"ptudjckqis\",
    \"for_classification\": \"no\",
    \"for_project\": \"yes\"
}"
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": 18,
    "project_id": 14,
    "classification": "eum",
    "document": "ptudjckqis",
    "for_classification": "no",
    "for_project": "yes"
};

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' => 18,
            'project_id' => 14,
            'classification' => 'eum',
            'document' => 'ptudjckqis',
            'for_classification' => 'no',
            'for_project' => 'yes',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/assets_reports'
payload = {
    "organization_id": 18,
    "project_id": 14,
    "classification": "eum",
    "document": "ptudjckqis",
    "for_classification": "no",
    "for_project": "yes"
}
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   

Example: 18

project_id   integer  optional  

This field is required when for_project is yes. Example: 14

classification   string  optional  

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

document   string  optional  

Must not be greater than 1024 characters. Example: ptudjckqis

for_classification   string   

Example: no

Must be one of:
  • yes
  • no
for_project   string   

Example: yes

Must be one of:
  • yes
  • no

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\": \"lbernhard@example.com\",
    \"password\": \"31Q#Ky.]?N\\\\(L3*x\"
}"
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": "lbernhard@example.com",
    "password": "31Q#Ky.]?N\\(L3*x"
};

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' => 'lbernhard@example.com',
            'password' => '31Q#Ky.]?N\\(L3*x',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/login'
payload = {
    "email": "lbernhard@example.com",
    "password": "31Q#Ky.]?N\\(L3*x"
}
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: lbernhard@example.com

password   string   

The password of the user Example: 31Q#Ky.]?N\(L3*x

Reset user password

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

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

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

let body = {
    "email": "manuel.boyer@example.net"
};

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' => 'allie.dooley@example.org',
        ],
        'json' => [
            'email' => 'manuel.boyer@example.net',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/reset_password'
payload = {
    "email": "manuel.boyer@example.net"
}
params = {
  'email': 'allie.dooley@example.org',
}
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: allie.dooley@example.org

Body Parameters

email   string   

Must be a valid email address. Example: manuel.boyer@example.net

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\": \"et\",
    \"middle_name\": \"et\",
    \"last_name\": \"et\",
    \"designation\": \"nihil\",
    \"staff_id\": \"in\",
    \"email\": \"edd10@example.net\",
    \"organization_id\": 12,
    \"roles\": [
        \"vero\"
    ]
}"
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": "et",
    "middle_name": "et",
    "last_name": "et",
    "designation": "nihil",
    "staff_id": "in",
    "email": "edd10@example.net",
    "organization_id": 12,
    "roles": [
        "vero"
    ]
};

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' => 'et',
            'middle_name' => 'et',
            'last_name' => 'et',
            'designation' => 'nihil',
            'staff_id' => 'in',
            'email' => 'edd10@example.net',
            'organization_id' => 12,
            'roles' => [
                'vero',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/create_user'
payload = {
    "first_name": "et",
    "middle_name": "et",
    "last_name": "et",
    "designation": "nihil",
    "staff_id": "in",
    "email": "edd10@example.net",
    "organization_id": 12,
    "roles": [
        "vero"
    ]
}
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: et

middle_name   string   

Example: et

last_name   string   

Example: et

designation   string   

Example: nihil

staff_id   string   

Example: in

email   string   

Must be a valid email address. Example: edd10@example.net

organization_id   integer   

Example: 12

roles   string[]  optional  

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=o%5C%5EB%3FZsxam8%40%5DU%2CG%2A" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"current_password\": \"et\",
    \"new_password\": \"consequatur\"
}"
const url = new URL(
    "https://api.cithar.com/api/update_password"
);

const params = {
    "password": "o\^B?Zsxam8@]U,G*",
};
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": "et",
    "new_password": "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_password';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'password' => 'o\^B?Zsxam8@]U,G*',
        ],
        'json' => [
            'current_password' => 'et',
            'new_password' => 'consequatur',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/update_password'
payload = {
    "current_password": "et",
    "new_password": "consequatur"
}
params = {
  'password': 'o\^B?Zsxam8@]U,G*',
}
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: o\^B?Zsxam8@]U,G*

Body Parameters

current_password   string   

Example: et

new_password   string   

The value and current_password must be different. Example: consequatur

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=5" \
    --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": "5",
};
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' => '5',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/requisitions'
params = {
  'per_page': '5',
}
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-05T10:48:49.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:48:49.000000Z",
            "updated_at": "2024-03-05T10: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: 5

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\": 19,
    \"approver\": 1,
    \"approver_role\": \"illo\",
    \"organization_id\": 1,
    \"project_id\": 12,
    \"title\": \"laudantium\",
    \"type\": \"cash\",
    \"activity_type\": \"exercitationem\",
    \"description\": \"Sequi reprehenderit magnam consequatur molestiae aut aut illo.\",
    \"start_date\": \"2025-01-26T17:33:45\",
    \"end_date\": \"2025-01-26T17:33:45\",
    \"cost_items\": [
        \"molestiae\"
    ],
    \"beneficiaries_details\": [
        \"nulla\"
    ]
}"
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": 19,
    "approver": 1,
    "approver_role": "illo",
    "organization_id": 1,
    "project_id": 12,
    "title": "laudantium",
    "type": "cash",
    "activity_type": "exercitationem",
    "description": "Sequi reprehenderit magnam consequatur molestiae aut aut illo.",
    "start_date": "2025-01-26T17:33:45",
    "end_date": "2025-01-26T17:33:45",
    "cost_items": [
        "molestiae"
    ],
    "beneficiaries_details": [
        "nulla"
    ]
};

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' => 19,
            'approver' => 1,
            'approver_role' => 'illo',
            'organization_id' => 1,
            'project_id' => 12,
            'title' => 'laudantium',
            'type' => 'cash',
            'activity_type' => 'exercitationem',
            'description' => 'Sequi reprehenderit magnam consequatur molestiae aut aut illo.',
            'start_date' => '2025-01-26T17:33:45',
            'end_date' => '2025-01-26T17:33:45',
            'cost_items' => [
                'molestiae',
            ],
            'beneficiaries_details' => [
                'nulla',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/requisitions'
payload = {
    "created_by": 19,
    "approver": 1,
    "approver_role": "illo",
    "organization_id": 1,
    "project_id": 12,
    "title": "laudantium",
    "type": "cash",
    "activity_type": "exercitationem",
    "description": "Sequi reprehenderit magnam consequatur molestiae aut aut illo.",
    "start_date": "2025-01-26T17:33:45",
    "end_date": "2025-01-26T17:33:45",
    "cost_items": [
        "molestiae"
    ],
    "beneficiaries_details": [
        "nulla"
    ]
}
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-05T10:48:49.000000Z",
        "updated_at": "2024-03-05T10: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   

Example: 19

approver   integer   

Example: 1

approver_role   string   

Example: illo

organization_id   integer  optional  

Example: 1

project_id   integer  optional  

Example: 12

title   string   

Example: laudantium

type   string  optional  

Example: cash

Must be one of:
  • bank_transfer
  • cash
activity_type   string   

Example: exercitationem

description   string   

Example: Sequi reprehenderit magnam consequatur molestiae aut aut illo.

start_date   string   

Must be a valid date. Example: 2025-01-26T17:33:45

end_date   string   

Must be a valid date. Example: 2025-01-26T17:33:45

cost_items   string[]   
cost_title   string   

Example: accusantium

unit_price   string   

Example: nulla

quantity   integer   

Example: 8

no_of_persons   integer   

Example: 2

total   string   

Example: voluptas

oca   integer  optional  

Example: 20

pca   integer  optional  

Example: 9

frequency_of_occurrence   string  optional  

Example: excepturi

justification   string  optional  

Example: cumque

beneficiaries_details   string[]  optional  
amount   string  optional  

Example: alias

bank_name   string  optional  

Example: atque

account_number   string  optional  

Example: quo

account_name   string  optional  

Example: possimus

bank_sort_code   string  optional  

Example: aut

serial_number   integer  optional  

Example: 7

narration   string   

Example: ducimus

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-05T10:48:49.000000Z",
        "updated_at": "2024-03-05T10: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/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 3,
    \"approver\": 17,
    \"approver_role\": \"animi\",
    \"organization_id\": 2,
    \"project_id\": 5,
    \"title\": \"aut\",
    \"type\": \"cash\",
    \"activity_type\": \"quia\",
    \"description\": \"Vero libero et hic eos quam.\",
    \"start_date\": \"2025-01-26T17:33:45\",
    \"end_date\": \"2025-01-26T17:33:45\",
    \"cost_items\": [
        \"odit\"
    ],
    \"beneficiaries_details\": [
        \"dolorem\"
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/requisitions/architecto"
);

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

let body = {
    "created_by": 3,
    "approver": 17,
    "approver_role": "animi",
    "organization_id": 2,
    "project_id": 5,
    "title": "aut",
    "type": "cash",
    "activity_type": "quia",
    "description": "Vero libero et hic eos quam.",
    "start_date": "2025-01-26T17:33:45",
    "end_date": "2025-01-26T17:33:45",
    "cost_items": [
        "odit"
    ],
    "beneficiaries_details": [
        "dolorem"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/requisitions/architecto';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 3,
            'approver' => 17,
            'approver_role' => 'animi',
            'organization_id' => 2,
            'project_id' => 5,
            'title' => 'aut',
            'type' => 'cash',
            'activity_type' => 'quia',
            'description' => 'Vero libero et hic eos quam.',
            'start_date' => '2025-01-26T17:33:45',
            'end_date' => '2025-01-26T17:33:45',
            'cost_items' => [
                'odit',
            ],
            'beneficiaries_details' => [
                'dolorem',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/requisitions/architecto'
payload = {
    "created_by": 3,
    "approver": 17,
    "approver_role": "animi",
    "organization_id": 2,
    "project_id": 5,
    "title": "aut",
    "type": "cash",
    "activity_type": "quia",
    "description": "Vero libero et hic eos quam.",
    "start_date": "2025-01-26T17:33:45",
    "end_date": "2025-01-26T17:33:45",
    "cost_items": [
        "odit"
    ],
    "beneficiaries_details": [
        "dolorem"
    ]
}
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: architecto

Body Parameters

created_by   integer  optional  

Example: 3

approver   integer  optional  

Example: 17

approver_role   string  optional  

Example: animi

organization_id   integer  optional  

Example: 2

project_id   integer  optional  

Example: 5

title   string  optional  

Example: aut

type   string  optional  

Example: cash

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

Example: quia

description   string  optional  

Example: Vero libero et hic eos quam.

start_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:45

end_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:45

cost_items   integer[]  optional  
id   integer  optional  

Example: 11

cost_title   string   

Example: quis

unit_price   string  optional  

Example: debitis

quantity   integer  optional  

Example: 13

no_of_persons   integer  optional  

Example: 18

total   string  optional  

Example: atque

oca   integer  optional  

Example: 6

pca   integer  optional  

Example: 16

frequency_of_occurrence   string  optional  

Example: alias

justification   string  optional  

Example: maiores

beneficiaries_details   integer[]  optional  
id   integer  optional  

Example: 20

amount   string  optional  

Example: non

bank_name   string  optional  

Example: eveniet

account_number   string  optional  

Example: assumenda

account_name   string   

Example: perferendis

bank_sort_code   string  optional  

Example: voluptas

serial_number   integer  optional  

Example: 17

narration   string  optional  

Example: est

Display a listing of the Banks.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/banks?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/banks"
);

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/banks';
$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/banks'
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/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: 14

Validate a give Bank Account.

requires authentication

Example request:
curl --request POST \
    "https://api.cithar.com/api/banks?account_number=15&bank_code=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/banks"
);

const params = {
    "account_number": "15",
    "bank_code": "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: "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' => '16',
        ],
    ]
);
$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': '16',
}
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: 16

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

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=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/retirements"
);

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/retirements';
$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/retirements'
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,
            "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-05T10:50:40.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:48:49.000000Z",
                "updated_at": "2024-03-05T10: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-05T10:48:49.000000Z",
                    "updated_at": "2024-03-05T10: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-05T10:50:40.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:48:49.000000Z",
                "updated_at": "2024-03-05T10: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-05T10:48:49.000000Z",
                    "updated_at": "2024-03-05T10: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: 16

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\": 15,
    \"organization_id\": 10,
    \"project_id\": 3,
    \"created_by\": 9,
    \"approver\": 2,
    \"approver_role\": \"aut\",
    \"related_document\": \"architecto\",
    \"report_document\": \"velit\",
    \"cost_items\": [
        9
    ]
}"
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": 15,
    "organization_id": 10,
    "project_id": 3,
    "created_by": 9,
    "approver": 2,
    "approver_role": "aut",
    "related_document": "architecto",
    "report_document": "velit",
    "cost_items": [
        9
    ]
};

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' => 15,
            'organization_id' => 10,
            'project_id' => 3,
            'created_by' => 9,
            'approver' => 2,
            'approver_role' => 'aut',
            'related_document' => 'architecto',
            'report_document' => 'velit',
            'cost_items' => [
                9,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/retirements'
payload = {
    "requisition_id": 15,
    "organization_id": 10,
    "project_id": 3,
    "created_by": 9,
    "approver": 2,
    "approver_role": "aut",
    "related_document": "architecto",
    "report_document": "velit",
    "cost_items": [
        9
    ]
}
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-05T10:50:40.000000Z",
        "updated_at": "2024-03-05T10: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-05T10:48:49.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:48:49.000000Z",
                "updated_at": "2024-03-05T10: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   

Example: 15

organization_id   integer   

Example: 10

project_id   integer   

Example: 3

created_by   integer   

Example: 9

approver   integer  optional  

Example: 2

approver_role   string  optional  

Example: aut

related_document   string  optional  

Example: architecto

report_document   string  optional  

Example: velit

cost_items   integer[]  optional  

Show the specified retirement.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/retirements/nihil" \
    --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/nihil"
);

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/nihil';
$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/nihil'
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-05T10:50:40.000000Z",
        "updated_at": "2024-03-05T10: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-05T10:48:49.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:48:49.000000Z",
                "updated_at": "2024-03-05T10: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: nihil

Update the specified retirement.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/retirements/sunt" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"request_type\": \"timesheet\",
    \"approver\": 9,
    \"approver_role\": \"sit\",
    \"previous_approver_role\": \"mollitia\",
    \"status\": \"approved\",
    \"remark\": \"explicabo\",
    \"related_document\": \"odit\",
    \"report_document\": \"sit\",
    \"request_model_id\": \"repellendus\"
}"
const url = new URL(
    "https://api.cithar.com/api/retirements/sunt"
);

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

let body = {
    "request_type": "timesheet",
    "approver": 9,
    "approver_role": "sit",
    "previous_approver_role": "mollitia",
    "status": "approved",
    "remark": "explicabo",
    "related_document": "odit",
    "report_document": "sit",
    "request_model_id": "repellendus"
};

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

url = 'https://api.cithar.com/api/retirements/sunt'
payload = {
    "request_type": "timesheet",
    "approver": 9,
    "approver_role": "sit",
    "previous_approver_role": "mollitia",
    "status": "approved",
    "remark": "explicabo",
    "related_document": "odit",
    "report_document": "sit",
    "request_model_id": "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()

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: sunt

Body Parameters

request_type   string   

Example: timesheet

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

Example: 9

approver_role   string  optional  

This field is required when approver is present. Example: sit

previous_approver_role   string  optional  

Example: mollitia

status   string  optional  

Example: approved

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

Example: explicabo

related_document   string  optional  

Example: odit

report_document   string  optional  

Example: sit

request_model_id   string   

Example: repellendus

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\": 10,
    \"organization_id\": 17,
    \"project_id\": 18,
    \"created_by\": 6,
    \"cost_title\": \"eius\",
    \"unit_price\": \"nobis\",
    \"quantity\": 20,
    \"no_of_persons\": 15,
    \"total\": \"eaque\",
    \"oca\": 19,
    \"pca\": 4,
    \"frequency_of_occurrence\": \"et\",
    \"justification\": \"eum\",
    \"parent_id\": 13
}"
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": 10,
    "organization_id": 17,
    "project_id": 18,
    "created_by": 6,
    "cost_title": "eius",
    "unit_price": "nobis",
    "quantity": 20,
    "no_of_persons": 15,
    "total": "eaque",
    "oca": 19,
    "pca": 4,
    "frequency_of_occurrence": "et",
    "justification": "eum",
    "parent_id": 13
};

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' => 10,
            'organization_id' => 17,
            'project_id' => 18,
            'created_by' => 6,
            'cost_title' => 'eius',
            'unit_price' => 'nobis',
            'quantity' => 20,
            'no_of_persons' => 15,
            'total' => 'eaque',
            'oca' => 19,
            'pca' => 4,
            'frequency_of_occurrence' => 'et',
            'justification' => 'eum',
            'parent_id' => 13,
        ],
    ]
);
$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": 10,
    "organization_id": 17,
    "project_id": 18,
    "created_by": 6,
    "cost_title": "eius",
    "unit_price": "nobis",
    "quantity": 20,
    "no_of_persons": 15,
    "total": "eaque",
    "oca": 19,
    "pca": 4,
    "frequency_of_occurrence": "et",
    "justification": "eum",
    "parent_id": 13
}
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   

Example: 10

organization_id   integer   

Example: 17

project_id   integer   

Example: 18

created_by   integer   

Example: 6

cost_title   string   

Example: eius

unit_price   string   

Example: nobis

quantity   integer   

Example: 20

no_of_persons   integer   

Example: 15

total   string   

Example: eaque

oca   integer  optional  

Example: 19

pca   integer  optional  

Example: 4

frequency_of_occurrence   string  optional  

Example: et

justification   string  optional  

Example: eum

parent_id   integer   

Example: 13

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\": 9,
    \"organization_id\": 17,
    \"project_id\": 8,
    \"created_by\": 17,
    \"cost_title\": \"at\",
    \"unit_price\": \"culpa\",
    \"quantity\": 15,
    \"no_of_persons\": 1,
    \"total\": \"unde\",
    \"oca\": 7,
    \"pca\": 13,
    \"frequency_of_occurrence\": \"ut\",
    \"justification\": \"sit\",
    \"parent_id\": 10
}"
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": 9,
    "organization_id": 17,
    "project_id": 8,
    "created_by": 17,
    "cost_title": "at",
    "unit_price": "culpa",
    "quantity": 15,
    "no_of_persons": 1,
    "total": "unde",
    "oca": 7,
    "pca": 13,
    "frequency_of_occurrence": "ut",
    "justification": "sit",
    "parent_id": 10
};

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' => 9,
            'organization_id' => 17,
            'project_id' => 8,
            'created_by' => 17,
            'cost_title' => 'at',
            'unit_price' => 'culpa',
            'quantity' => 15,
            'no_of_persons' => 1,
            'total' => 'unde',
            'oca' => 7,
            'pca' => 13,
            'frequency_of_occurrence' => 'ut',
            'justification' => 'sit',
            'parent_id' => 10,
        ],
    ]
);
$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": 9,
    "organization_id": 17,
    "project_id": 8,
    "created_by": 17,
    "cost_title": "at",
    "unit_price": "culpa",
    "quantity": 15,
    "no_of_persons": 1,
    "total": "unde",
    "oca": 7,
    "pca": 13,
    "frequency_of_occurrence": "ut",
    "justification": "sit",
    "parent_id": 10
}
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  

Example: 9

organization_id   integer   

Example: 17

project_id   integer   

Example: 8

created_by   integer   

Example: 17

cost_title   string   

Example: at

unit_price   string   

Example: culpa

quantity   integer   

Example: 15

no_of_persons   integer   

Example: 1

total   string   

Example: unde

oca   integer  optional  

Example: 7

pca   integer  optional  

Example: 13

frequency_of_occurrence   string  optional  

Example: ut

justification   string  optional  

Example: sit

parent_id   integer  optional  

Example: 10

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=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/accounts"
);

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/accounts';
$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/accounts'
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 (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-20T17:27:36.000000Z",
            "updated_at": "2024-04-23T11: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-20T17:27:36.000000Z",
            "updated_at": "2024-04-23T11: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: 18

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\": 10,
    \"organization_id\": 3,
    \"project_id\": 8,
    \"account_name\": \"dolores\",
    \"account_number\": 19,
    \"amount\": \"ad\",
    \"bank_name\": \"ipsum\"
}"
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": 10,
    "organization_id": 3,
    "project_id": 8,
    "account_name": "dolores",
    "account_number": 19,
    "amount": "ad",
    "bank_name": "ipsum"
};

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' => 10,
            'organization_id' => 3,
            'project_id' => 8,
            'account_name' => 'dolores',
            'account_number' => 19,
            'amount' => 'ad',
            'bank_name' => 'ipsum',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/accounts'
payload = {
    "created_by": 10,
    "organization_id": 3,
    "project_id": 8,
    "account_name": "dolores",
    "account_number": 19,
    "amount": "ad",
    "bank_name": "ipsum"
}
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-20T17:27:36.000000Z",
            "updated_at": "2024-04-23T11: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-20T17:27:36.000000Z",
            "updated_at": "2024-04-23T11: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   

Example: 10

organization_id   integer  optional  

Example: 3

project_id   integer   

Example: 8

account_name   string   

Example: dolores

account_number   integer   

Example: 19

amount   string   

Example: ad

bank_name   string   

Example: ipsum

Show the specified Account.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/accounts/commodi" \
    --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/commodi"
);

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/commodi';
$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/commodi'
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-20T17:27:36.000000Z",
            "updated_at": "2024-04-23T11: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-20T17:27:36.000000Z",
            "updated_at": "2024-04-23T11: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: commodi

Update the specified Account.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/accounts/sunt" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 6,
    \"organization_id\": 18,
    \"project_id\": 6,
    \"account_name\": \"id\",
    \"account_number\": 15,
    \"bank_name\": \"est\"
}"
const url = new URL(
    "https://api.cithar.com/api/accounts/sunt"
);

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

let body = {
    "created_by": 6,
    "organization_id": 18,
    "project_id": 6,
    "account_name": "id",
    "account_number": 15,
    "bank_name": "est"
};

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

url = 'https://api.cithar.com/api/accounts/sunt'
payload = {
    "created_by": 6,
    "organization_id": 18,
    "project_id": 6,
    "account_name": "id",
    "account_number": 15,
    "bank_name": "est"
}
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-20T17:27:36.000000Z",
            "updated_at": "2024-04-23T11: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-20T17:27:36.000000Z",
            "updated_at": "2024-04-23T11: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: sunt

Body Parameters

created_by   integer  optional  

Example: 6

organization_id   integer  optional  

Example: 18

project_id   integer  optional  

Example: 6

account_name   string  optional  

Example: id

account_number   integer  optional  

Example: 15

amount   string  optional  
bank_name   string  optional  

Example: est

Remove the specified Account.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/accounts/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/accounts/id"
);

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/id';
$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/id'
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-20T17:27:36.000000Z",
            "updated_at": "2024-04-23T11: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-20T17:27:36.000000Z",
            "updated_at": "2024-04-23T11: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: id

Display a listing of the Account Transactions.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/account_transactions?per_page=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/account_transactions"
);

const params = {
    "per_page": "19",
};
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' => '19',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/account_transactions'
params = {
  'per_page': '19',
}
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-09T11:11:01.000000Z",
            "updated_at": "2024-05-09T11: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-09T11:11:01.000000Z",
            "updated_at": "2024-05-09T11: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: 19

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\": 6,
    \"organization_id\": 17,
    \"project_id\": 17,
    \"account_id\": 16,
    \"amount\": \"itaque\",
    \"justification\": \"autem\",
    \"type\": \"outflow\",
    \"requisition_id\": 20,
    \"retirement_id\": 20,
    \"cost_title\": \"ea\",
    \"unit_price\": \"non\",
    \"quantity\": 7,
    \"no_of_persons\": 4,
    \"total\": \"possimus\",
    \"oca\": 14,
    \"pca\": 15,
    \"frequency_of_occurrence\": \"dicta\"
}"
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": 6,
    "organization_id": 17,
    "project_id": 17,
    "account_id": 16,
    "amount": "itaque",
    "justification": "autem",
    "type": "outflow",
    "requisition_id": 20,
    "retirement_id": 20,
    "cost_title": "ea",
    "unit_price": "non",
    "quantity": 7,
    "no_of_persons": 4,
    "total": "possimus",
    "oca": 14,
    "pca": 15,
    "frequency_of_occurrence": "dicta"
};

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' => 6,
            'organization_id' => 17,
            'project_id' => 17,
            'account_id' => 16,
            'amount' => 'itaque',
            'justification' => 'autem',
            'type' => 'outflow',
            'requisition_id' => 20,
            'retirement_id' => 20,
            'cost_title' => 'ea',
            'unit_price' => 'non',
            'quantity' => 7,
            'no_of_persons' => 4,
            'total' => 'possimus',
            'oca' => 14,
            'pca' => 15,
            'frequency_of_occurrence' => 'dicta',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/account_transactions'
payload = {
    "created_by": 6,
    "organization_id": 17,
    "project_id": 17,
    "account_id": 16,
    "amount": "itaque",
    "justification": "autem",
    "type": "outflow",
    "requisition_id": 20,
    "retirement_id": 20,
    "cost_title": "ea",
    "unit_price": "non",
    "quantity": 7,
    "no_of_persons": 4,
    "total": "possimus",
    "oca": 14,
    "pca": 15,
    "frequency_of_occurrence": "dicta"
}
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-05T10:48:49.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:48:49.000000Z",
            "updated_at": "2024-03-05T10: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   

Example: 6

organization_id   integer  optional  

Example: 17

project_id   integer   

Example: 17

account_id   integer   

Example: 16

amount   string   

Example: itaque

justification   string   

Example: autem

type   string   

Example: outflow

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

This field is required when type is outflow. Example: 20

retirement_id   integer  optional  

This field is required when type is outflow. Example: 20

cost_title   string   

Example: ea

unit_price   string   

Example: non

quantity   integer   

Example: 7

no_of_persons   integer   

Example: 4

total   string   

Example: possimus

oca   integer  optional  

Example: 14

pca   integer  optional  

Example: 15

frequency_of_occurrence   string   

Example: dicta

Show the specified Account Transaction.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/account_transactions/impedit" \
    --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/impedit"
);

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/impedit';
$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/impedit'
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-05T10:48:49.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:48:49.000000Z",
            "updated_at": "2024-03-05T10: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: impedit

Update the specified Account Transaction.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/account_transactions/tenetur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 15,
    \"organization_id\": 7,
    \"project_id\": 5,
    \"account_id\": 14,
    \"retirement_id\": 16,
    \"amount\": \"repellat\",
    \"justification\": \"et\",
    \"type\": \"outflow\",
    \"cost_items_id\": 17,
    \"requisition_id\": 8,
    \"cost_title\": \"modi\",
    \"unit_price\": \"non\",
    \"quantity\": 18,
    \"no_of_persons\": 8,
    \"total\": \"non\",
    \"oca\": 10,
    \"pca\": 6,
    \"frequency_of_occurrence\": \"porro\"
}"
const url = new URL(
    "https://api.cithar.com/api/account_transactions/tenetur"
);

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

let body = {
    "created_by": 15,
    "organization_id": 7,
    "project_id": 5,
    "account_id": 14,
    "retirement_id": 16,
    "amount": "repellat",
    "justification": "et",
    "type": "outflow",
    "cost_items_id": 17,
    "requisition_id": 8,
    "cost_title": "modi",
    "unit_price": "non",
    "quantity": 18,
    "no_of_persons": 8,
    "total": "non",
    "oca": 10,
    "pca": 6,
    "frequency_of_occurrence": "porro"
};

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/tenetur';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 15,
            'organization_id' => 7,
            'project_id' => 5,
            'account_id' => 14,
            'retirement_id' => 16,
            'amount' => 'repellat',
            'justification' => 'et',
            'type' => 'outflow',
            'cost_items_id' => 17,
            'requisition_id' => 8,
            'cost_title' => 'modi',
            'unit_price' => 'non',
            'quantity' => 18,
            'no_of_persons' => 8,
            'total' => 'non',
            'oca' => 10,
            'pca' => 6,
            'frequency_of_occurrence' => 'porro',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/account_transactions/tenetur'
payload = {
    "created_by": 15,
    "organization_id": 7,
    "project_id": 5,
    "account_id": 14,
    "retirement_id": 16,
    "amount": "repellat",
    "justification": "et",
    "type": "outflow",
    "cost_items_id": 17,
    "requisition_id": 8,
    "cost_title": "modi",
    "unit_price": "non",
    "quantity": 18,
    "no_of_persons": 8,
    "total": "non",
    "oca": 10,
    "pca": 6,
    "frequency_of_occurrence": "porro"
}
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-05T10:48:49.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:48:49.000000Z",
            "updated_at": "2024-03-05T10: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: tenetur

Body Parameters

created_by   integer  optional  

Example: 15

organization_id   integer  optional  

Example: 7

project_id   integer  optional  

Example: 5

account_id   integer  optional  

Example: 14

retirement_id   integer  optional  

Example: 16

amount   string  optional  

Example: repellat

justification   string  optional  

Example: et

type   string   

Example: outflow

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

Example: 17

requisition_id   integer  optional  

Example: 8

cost_title   string  optional  

Example: modi

unit_price   string  optional  

Example: non

quantity   integer  optional  

Example: 18

no_of_persons   integer  optional  

Example: 8

total   string  optional  

Example: non

oca   integer  optional  

Example: 10

pca   integer  optional  

Example: 6

frequency_of_occurrence   string  optional  

Example: porro

Remove the specified Account Transaction.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/account_transactions/atque" \
    --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/atque"
);

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/atque';
$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/atque'
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-05T10:48:49.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:48:49.000000Z",
            "updated_at": "2024-03-05T10: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: atque

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=20&type=impedit" \
    --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": "20",
    "type": "impedit",
};
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' => '20',
            'type' => 'impedit',
        ],
    ]
);
$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': '20',
  'type': 'impedit',
}
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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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: 20

type   string  optional  

filter by pca and oca Example: impedit

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\": 8,
    \"organization_id\": 7,
    \"project_id\": 3,
    \"description\": \"Et voluptatem voluptatibus omnis veritatis aut et.\",
    \"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": 8,
    "organization_id": 7,
    "project_id": 3,
    "description": "Et voluptatem voluptatibus omnis veritatis aut et.",
    "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' => 8,
            'organization_id' => 7,
            'project_id' => 3,
            'description' => 'Et voluptatem voluptatibus omnis veritatis aut et.',
            '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": 8,
    "organization_id": 7,
    "project_id": 3,
    "description": "Et voluptatem voluptatibus omnis veritatis aut et.",
    "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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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   

Example: 8

organization_id   integer  optional  

Example: 7

project_id   integer  optional  

This field is required when type is pca. Example: 3

description   string   

Example: Et voluptatem voluptatibus omnis veritatis aut et.

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/non" \
    --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/non"
);

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/non';
$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/non'
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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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: non

Update the specified Chart of Accounts.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/chart_of_accounts/tempora" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 2,
    \"organization_id\": 18,
    \"project_id\": 20,
    \"description\": \"Voluptatibus nemo illo in ab perferendis et.\",
    \"code\": 6,
    \"type\": \"oca\"
}"
const url = new URL(
    "https://api.cithar.com/api/chart_of_accounts/tempora"
);

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

let body = {
    "created_by": 2,
    "organization_id": 18,
    "project_id": 20,
    "description": "Voluptatibus nemo illo in ab perferendis et.",
    "code": 6,
    "type": "oca"
};

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/tempora';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 2,
            'organization_id' => 18,
            'project_id' => 20,
            'description' => 'Voluptatibus nemo illo in ab perferendis et.',
            'code' => 6,
            'type' => 'oca',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/chart_of_accounts/tempora'
payload = {
    "created_by": 2,
    "organization_id": 18,
    "project_id": 20,
    "description": "Voluptatibus nemo illo in ab perferendis et.",
    "code": 6,
    "type": "oca"
}
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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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: tempora

Body Parameters

created_by   integer  optional  

Example: 2

organization_id   integer  optional  

Example: 18

project_id   integer  optional  

Example: 20

description   string  optional  

Example: Voluptatibus nemo illo in ab perferendis et.

code   integer  optional  

Example: 6

type   string  optional  

Example: oca

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/earum" \
    --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/earum"
);

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/earum';
$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/earum'
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: earum

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\": 6,
    \"organization_id\": 18,
    \"project_id\": 5,
    \"retirement_id\": 19,
    \"amount\": \"illo\",
    \"bank_name\": \"architecto\",
    \"account_number\": \"sapiente\",
    \"account_name\": \"voluptates\",
    \"bank_sort_code\": \"rerum\",
    \"serial_number\": \"ad\",
    \"narration\": \"inventore\"
}"
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": 6,
    "organization_id": 18,
    "project_id": 5,
    "retirement_id": 19,
    "amount": "illo",
    "bank_name": "architecto",
    "account_number": "sapiente",
    "account_name": "voluptates",
    "bank_sort_code": "rerum",
    "serial_number": "ad",
    "narration": "inventore"
};

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' => 6,
            'organization_id' => 18,
            'project_id' => 5,
            'retirement_id' => 19,
            'amount' => 'illo',
            'bank_name' => 'architecto',
            'account_number' => 'sapiente',
            'account_name' => 'voluptates',
            'bank_sort_code' => 'rerum',
            'serial_number' => 'ad',
            'narration' => 'inventore',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/beneficiaries'
payload = {
    "created_by": 6,
    "organization_id": 18,
    "project_id": 5,
    "retirement_id": 19,
    "amount": "illo",
    "bank_name": "architecto",
    "account_number": "sapiente",
    "account_name": "voluptates",
    "bank_sort_code": "rerum",
    "serial_number": "ad",
    "narration": "inventore"
}
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   

Example: 6

organization_id   integer   

Example: 18

project_id   integer   

Example: 5

retirement_id   integer  optional  

Example: 19

amount   string  optional  

Example: illo

bank_name   string  optional  

Example: architecto

account_number   string  optional  

Example: sapiente

account_name   string   

Example: voluptates

bank_sort_code   string  optional  

Example: rerum

serial_number   string  optional  

Example: ad

narration   string  optional  

Example: inventore

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\": 13,
    \"oca\": \"quia\",
    \"pca\": \"quo\"
}"
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": 13,
    "oca": "quia",
    "pca": "quo"
};

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' => 13,
            'oca' => 'quia',
            'pca' => 'quo',
        ],
    ]
);
$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": 13,
    "oca": "quia",
    "pca": "quo"
}
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   

Example: 13

oca   string  optional  

Example: quia

pca   string  optional  

Example: quo

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\": \"sunt\",
    \"type\": \"cost_item\",
    \"cost_item_id\": 1,
    \"beneficiary_detail_id\": 3
}"
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": "sunt",
    "type": "cost_item",
    "cost_item_id": 1,
    "beneficiary_detail_id": 3
};

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' => 'sunt',
            'type' => 'cost_item',
            'cost_item_id' => 1,
            'beneficiary_detail_id' => 3,
        ],
    ]
);
$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": "sunt",
    "type": "cost_item",
    "cost_item_id": 1,
    "beneficiary_detail_id": 3
}
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   

Example: sunt

type   string   

Example: cost_item

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

This field is required when type or cost_item is present. Example: 1

beneficiary_detail_id   integer  optional  

This field is required when type or beneficiary is present. Example: 3

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\": \"autem\",
    \"type\": \"beneficiary\",
    \"cost_item_id\": 2,
    \"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": "autem",
    "type": "beneficiary",
    "cost_item_id": 2,
    "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' => 'autem',
            'type' => 'beneficiary',
            'cost_item_id' => 2,
            '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": "autem",
    "type": "beneficiary",
    "cost_item_id": 2,
    "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   

Example: autem

type   string   

Example: beneficiary

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

This field is required when type or cost_item is present. Example: 2

beneficiary_detail_id   integer  optional  

This field is required when type or beneficiary is present. Example: 1

Holiday Endpoints

Display a listing of Holidays.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/holidays?term=aut&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/holidays"
);

const params = {
    "term": "aut",
    "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/holidays';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'term' => 'aut',
            'per_page' => '4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/holidays'
params = {
  'term': 'aut',
  '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,
            "type": "private",
            "description": "gyhfgvhghgyfhgj",
            "organization_id": 12,
            "start_date": "2024-03-07",
            "end_date": "2024-03-08",
            "created_at": "2024-03-05T10:53:35.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:53:35.000000Z",
            "updated_at": "2024-03-05T10: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: aut

per_page   integer  optional  

Items per page Example: 4

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\": \"illo\",
    \"description\": \"Vel possimus enim doloremque assumenda expedita et.\",
    \"organization_id\": 6,
    \"start_date\": \"2025-01-26T17:33:46\",
    \"end_date\": \"2025-01-26T17:33:46\"
}"
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": "illo",
    "description": "Vel possimus enim doloremque assumenda expedita et.",
    "organization_id": 6,
    "start_date": "2025-01-26T17:33:46",
    "end_date": "2025-01-26T17:33:46"
};

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' => 'illo',
            'description' => 'Vel possimus enim doloremque assumenda expedita et.',
            'organization_id' => 6,
            'start_date' => '2025-01-26T17:33:46',
            'end_date' => '2025-01-26T17:33:46',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/holidays'
payload = {
    "type": "illo",
    "description": "Vel possimus enim doloremque assumenda expedita et.",
    "organization_id": 6,
    "start_date": "2025-01-26T17:33:46",
    "end_date": "2025-01-26T17:33:46"
}
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-05T10:53:35.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:53:35.000000Z",
            "updated_at": "2024-03-05T10: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: illo

description   string  optional  

Example: Vel possimus enim doloremque assumenda expedita et.

organization_id   integer   

Example: 6

start_date   string   

Must be a valid date. Example: 2025-01-26T17:33:46

end_date   string   

Must be a valid date. Example: 2025-01-26T17:33:46

Display the specified Holiday.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/holidays/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/holidays/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/holidays/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/holidays/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,
            "type": "private",
            "description": "gyhfgvhghgyfhgj",
            "organization_id": 12,
            "start_date": "2024-03-07",
            "end_date": "2024-03-08",
            "created_at": "2024-03-05T10:53:35.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:53:35.000000Z",
            "updated_at": "2024-03-05T10: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: 19

Update the specified Holiday.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/holidays/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"dolorem\",
    \"description\": \"Maxime amet voluptatibus quas.\",
    \"organization_id\": 14,
    \"start_date\": \"2025-01-26T17:33:46\",
    \"end_date\": \"2025-01-26T17:33:46\"
}"
const url = new URL(
    "https://api.cithar.com/api/holidays/1"
);

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

let body = {
    "type": "dolorem",
    "description": "Maxime amet voluptatibus quas.",
    "organization_id": 14,
    "start_date": "2025-01-26T17:33:46",
    "end_date": "2025-01-26T17:33:46"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/holidays/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'dolorem',
            'description' => 'Maxime amet voluptatibus quas.',
            'organization_id' => 14,
            'start_date' => '2025-01-26T17:33:46',
            'end_date' => '2025-01-26T17:33:46',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/holidays/1'
payload = {
    "type": "dolorem",
    "description": "Maxime amet voluptatibus quas.",
    "organization_id": 14,
    "start_date": "2025-01-26T17:33:46",
    "end_date": "2025-01-26T17:33:46"
}
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-05T10:53:35.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:53:35.000000Z",
            "updated_at": "2024-03-05T10: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: 1

Body Parameters

type   string  optional  

Example: dolorem

description   string  optional  

Example: Maxime amet voluptatibus quas.

organization_id   integer   

Example: 14

start_date   string   

Must be a valid date. Example: 2025-01-26T17:33:46

end_date   string   

Must be a valid date. Example: 2025-01-26T17:33:46

Remove the specified Holiday.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/holidays/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/holidays/4"
);

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/4';
$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/4'
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: 4

Leave Endpoints

Display a listing of the Assets.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/leaves?term=sequi&per_page=2&created_by=1&start_date=voluptatem&end_date=tenetur" \
    --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": "sequi",
    "per_page": "2",
    "created_by": "1",
    "start_date": "voluptatem",
    "end_date": "tenetur",
};
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' => 'sequi',
            'per_page' => '2',
            'created_by' => '1',
            'start_date' => 'voluptatem',
            'end_date' => 'tenetur',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/leaves'
params = {
  'term': 'sequi',
  'per_page': '2',
  'created_by': '1',
  'start_date': 'voluptatem',
  'end_date': 'tenetur',
}
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-05T10:19:02.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:19:02.000000Z",
            "updated_at": "2024-03-05T10: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: sequi

per_page   integer  optional  

Items per page Example: 2

created_by   integer  optional  

get a specific user leaves Example: 1

start_date   string  optional  

datetime filter by a date range Example: voluptatem

end_date   string  optional  

datetime filter by a date range Example: tenetur

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\": 4,
    \"approver\": 10,
    \"approver_role\": \"occaecati\",
    \"organization_id\": 9,
    \"start_date\": \"2025-01-26T17:33:46\",
    \"end_date\": \"2025-01-26T17:33:46\",
    \"type\": \"doloribus\",
    \"reason\": \"molestiae\",
    \"number_of_days\": 6
}"
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": 4,
    "approver": 10,
    "approver_role": "occaecati",
    "organization_id": 9,
    "start_date": "2025-01-26T17:33:46",
    "end_date": "2025-01-26T17:33:46",
    "type": "doloribus",
    "reason": "molestiae",
    "number_of_days": 6
};

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' => 4,
            'approver' => 10,
            'approver_role' => 'occaecati',
            'organization_id' => 9,
            'start_date' => '2025-01-26T17:33:46',
            'end_date' => '2025-01-26T17:33:46',
            'type' => 'doloribus',
            'reason' => 'molestiae',
            'number_of_days' => 6,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/leaves'
payload = {
    "user_id": 4,
    "approver": 10,
    "approver_role": "occaecati",
    "organization_id": 9,
    "start_date": "2025-01-26T17:33:46",
    "end_date": "2025-01-26T17:33:46",
    "type": "doloribus",
    "reason": "molestiae",
    "number_of_days": 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,
            "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-05T10:19:02.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:19:02.000000Z",
            "updated_at": "2024-03-05T10: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   

Example: 4

approver   integer   

Example: 10

approver_role   string   

Example: occaecati

organization_id   integer  optional  

Example: 9

start_date   string   

Must be a valid date. Example: 2025-01-26T17:33:46

end_date   string   

Must be a valid date. Example: 2025-01-26T17:33:46

type   string   

Example: doloribus

reason   string   

Example: molestiae

number_of_days   integer  optional  

Example: 6

Show a specified Leave.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/leaves/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/leaves/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/leaves/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/leaves/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,
            "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-05T10:19:02.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:19:02.000000Z",
            "updated_at": "2024-03-05T10: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: 3

Update the specified Leave.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/leaves/16" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 4,
    \"approver\": 9,
    \"approver_role\": \"dignissimos\",
    \"organization_id\": 3,
    \"start_date\": \"2025-01-26T17:33:46\",
    \"end_date\": \"2025-01-26T17:33:46\",
    \"type\": \"amet\",
    \"reason\": \"voluptatem\"
}"
const url = new URL(
    "https://api.cithar.com/api/leaves/16"
);

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

let body = {
    "user_id": 4,
    "approver": 9,
    "approver_role": "dignissimos",
    "organization_id": 3,
    "start_date": "2025-01-26T17:33:46",
    "end_date": "2025-01-26T17:33:46",
    "type": "amet",
    "reason": "voluptatem"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/leaves/16';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'user_id' => 4,
            'approver' => 9,
            'approver_role' => 'dignissimos',
            'organization_id' => 3,
            'start_date' => '2025-01-26T17:33:46',
            'end_date' => '2025-01-26T17:33:46',
            'type' => 'amet',
            'reason' => 'voluptatem',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/leaves/16'
payload = {
    "user_id": 4,
    "approver": 9,
    "approver_role": "dignissimos",
    "organization_id": 3,
    "start_date": "2025-01-26T17:33:46",
    "end_date": "2025-01-26T17:33:46",
    "type": "amet",
    "reason": "voluptatem"
}
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-05T10:19:02.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:19:02.000000Z",
            "updated_at": "2024-03-05T10: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: 16

Body Parameters

user_id   integer  optional  

Example: 4

approver   integer  optional  

Example: 9

approver_role   string  optional  

Example: dignissimos

organization_id   integer  optional  

Example: 3

start_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:46

end_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:46

type   string  optional  

Example: amet

reason   string  optional  

Example: voluptatem

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\": 12,
    \"user_id\": 15,
    \"start_date\": \"2025-01-26T17:33:46\",
    \"end_date\": \"2025-01-26T17:33:46\",
    \"type\": \"velit\"
}"
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": 12,
    "user_id": 15,
    "start_date": "2025-01-26T17:33:46",
    "end_date": "2025-01-26T17:33:46",
    "type": "velit"
};

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' => 12,
            'user_id' => 15,
            'start_date' => '2025-01-26T17:33:46',
            'end_date' => '2025-01-26T17:33:46',
            'type' => 'velit',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/leave_report'
payload = {
    "organization_id": 12,
    "user_id": 15,
    "start_date": "2025-01-26T17:33:46",
    "end_date": "2025-01-26T17:33:46",
    "type": "velit"
}
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   

Example: 12

user_id   integer   

Example: 15

start_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:46

end_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:46

type   string  optional  

Example: velit

Show the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/leave_report/aperiam" \
    --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/aperiam"
);

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/aperiam';
$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/aperiam'
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/aperiam 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: aperiam

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/leave_report/illum" \
    --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/illum"
);

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/illum';
$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/illum'
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: illum

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/leave_report/dolor" \
    --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/dolor"
);

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/dolor';
$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/dolor'
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: dolor

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=ratione&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/organizations"
);

const params = {
    "term": "ratione",
    "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/organizations';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'term' => 'ratione',
            'per_page' => '11',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/organizations'
params = {
  'term': 'ratione',
  '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": 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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                    "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                    "updated_at": "2024-03-03T20: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: ratione

per_page   integer  optional  

Items per page Example: 11

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\": \"est\",
    \"email\": \"desiree57@example.org\",
    \"phone_number\": \"dicta\",
    \"registration_number\": \"id\",
    \"country\": \"laborum\",
    \"state\": \"et\",
    \"city\": \"non\",
    \"postcode\": \"ut\",
    \"address\": \"dolor\",
    \"website\": \"http:\\/\\/kerluke.org\\/\",
    \"thematic_areas\": [
        \"ad\"
    ],
    \"account_codes\": [
        \"non\"
    ],
    \"organization_color\": \"iusto\",
    \"organization_logo\": \"asperiores\",
    \"noa_requisition\": 12,
    \"noa_requisition_names\": [
        \"totam\"
    ],
    \"noa_retirement\": 8,
    \"noa_retirement_names\": [
        \"possimus\"
    ],
    \"noa_leave\": 7,
    \"noa_leave_names\": [
        \"pariatur\"
    ],
    \"noa_timesheet\": 3,
    \"noa_timesheet_names\": [
        \"consectetur\"
    ],
    \"financial_year_start_month\": 4,
    \"financial_year_end_month\": 18,
    \"payment_voucher_number\": 20,
    \"month_start_day\": 9,
    \"month_end_day\": 5,
    \"hr_year_start_month\": 17,
    \"hr_year_end_month\": 5
}"
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": "est",
    "email": "desiree57@example.org",
    "phone_number": "dicta",
    "registration_number": "id",
    "country": "laborum",
    "state": "et",
    "city": "non",
    "postcode": "ut",
    "address": "dolor",
    "website": "http:\/\/kerluke.org\/",
    "thematic_areas": [
        "ad"
    ],
    "account_codes": [
        "non"
    ],
    "organization_color": "iusto",
    "organization_logo": "asperiores",
    "noa_requisition": 12,
    "noa_requisition_names": [
        "totam"
    ],
    "noa_retirement": 8,
    "noa_retirement_names": [
        "possimus"
    ],
    "noa_leave": 7,
    "noa_leave_names": [
        "pariatur"
    ],
    "noa_timesheet": 3,
    "noa_timesheet_names": [
        "consectetur"
    ],
    "financial_year_start_month": 4,
    "financial_year_end_month": 18,
    "payment_voucher_number": 20,
    "month_start_day": 9,
    "month_end_day": 5,
    "hr_year_start_month": 17,
    "hr_year_end_month": 5
};

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' => 'est',
            'email' => 'desiree57@example.org',
            'phone_number' => 'dicta',
            'registration_number' => 'id',
            'country' => 'laborum',
            'state' => 'et',
            'city' => 'non',
            'postcode' => 'ut',
            'address' => 'dolor',
            'website' => 'http://kerluke.org/',
            'thematic_areas' => [
                'ad',
            ],
            'account_codes' => [
                'non',
            ],
            'organization_color' => 'iusto',
            'organization_logo' => 'asperiores',
            'noa_requisition' => 12,
            'noa_requisition_names' => [
                'totam',
            ],
            'noa_retirement' => 8,
            'noa_retirement_names' => [
                'possimus',
            ],
            'noa_leave' => 7,
            'noa_leave_names' => [
                'pariatur',
            ],
            'noa_timesheet' => 3,
            'noa_timesheet_names' => [
                'consectetur',
            ],
            'financial_year_start_month' => 4,
            'financial_year_end_month' => 18,
            'payment_voucher_number' => 20,
            'month_start_day' => 9,
            'month_end_day' => 5,
            'hr_year_start_month' => 17,
            'hr_year_end_month' => 5,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/organizations'
payload = {
    "name": "est",
    "email": "desiree57@example.org",
    "phone_number": "dicta",
    "registration_number": "id",
    "country": "laborum",
    "state": "et",
    "city": "non",
    "postcode": "ut",
    "address": "dolor",
    "website": "http:\/\/kerluke.org\/",
    "thematic_areas": [
        "ad"
    ],
    "account_codes": [
        "non"
    ],
    "organization_color": "iusto",
    "organization_logo": "asperiores",
    "noa_requisition": 12,
    "noa_requisition_names": [
        "totam"
    ],
    "noa_retirement": 8,
    "noa_retirement_names": [
        "possimus"
    ],
    "noa_leave": 7,
    "noa_leave_names": [
        "pariatur"
    ],
    "noa_timesheet": 3,
    "noa_timesheet_names": [
        "consectetur"
    ],
    "financial_year_start_month": 4,
    "financial_year_end_month": 18,
    "payment_voucher_number": 20,
    "month_start_day": 9,
    "month_end_day": 5,
    "hr_year_start_month": 17,
    "hr_year_end_month": 5
}
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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                    "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                    "updated_at": "2024-03-03T20: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: est

email   string   

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

phone_number   string   

Example: dicta

registration_number   string   

Example: id

country   string   

Example: laborum

state   string   

Example: et

city   string   

Example: non

postcode   string  optional  

Example: ut

address   string   

Example: dolor

website   string   

Must be a valid URL. Example: http://kerluke.org/

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

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

description   string  optional  

This field is required when account_codes is present. Example: Et amet aperiam omnis.

organization_color   string  optional  

Example: iusto

organization_logo   string  optional  

Example: asperiores

noa_requisition   integer   

Example: 12

noa_requisition_names   string[]  optional  
noa_retirement   integer   

Example: 8

noa_retirement_names   string[]  optional  
noa_leave   integer   

Example: 7

noa_leave_names   string[]  optional  
noa_timesheet   integer   

Example: 3

noa_timesheet_names   string[]  optional  
financial_year_start_month   integer  optional  

Example: 4

financial_year_end_month   integer  optional  

Example: 18

payment_voucher_number   integer   

Example: 20

month_start_day   integer   

Example: 9

month_end_day   integer   

Example: 5

hr_year_start_month   integer  optional  

Example: 17

hr_year_end_month   integer  optional  

Example: 5

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/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/organizations/17"
);

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/17';
$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/17'
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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                    "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                    "updated_at": "2024-03-03T20: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: 17

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/organizations/9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"nesciunt\",
    \"email\": \"verla.buckridge@example.com\",
    \"phone_number\": \"deserunt\",
    \"registration_number\": \"debitis\",
    \"country\": \"et\",
    \"state\": \"architecto\",
    \"city\": \"aspernatur\",
    \"postcode\": \"nulla\",
    \"address\": \"possimus\",
    \"website\": \"http:\\/\\/shields.com\\/inventore-eos-exercitationem-et-debitis-odit-a-aut-quia\",
    \"thematic_areas\": [
        \"esse\"
    ],
    \"account_codes\": [
        \"eum\"
    ],
    \"organization_color\": \"facilis\",
    \"organization_logo\": \"aperiam\",
    \"noa_requisition\": 16,
    \"noa_requisition_names\": [
        \"aliquid\"
    ],
    \"noa_retirement\": 8,
    \"noa_retirement_names\": [
        \"hic\"
    ],
    \"noa_leave\": 4,
    \"noa_leave_names\": [
        \"voluptatem\"
    ],
    \"noa_timesheet\": 9,
    \"noa_timesheet_names\": [
        \"neque\"
    ],
    \"financial_year_start_month\": 1,
    \"financial_year_end_month\": 20,
    \"payment_voucher_number\": 9,
    \"month_start_day\": 3,
    \"month_end_day\": 16,
    \"hr_year_start_month\": 3,
    \"hr_year_end_month\": 12
}"
const url = new URL(
    "https://api.cithar.com/api/organizations/9"
);

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

let body = {
    "name": "nesciunt",
    "email": "verla.buckridge@example.com",
    "phone_number": "deserunt",
    "registration_number": "debitis",
    "country": "et",
    "state": "architecto",
    "city": "aspernatur",
    "postcode": "nulla",
    "address": "possimus",
    "website": "http:\/\/shields.com\/inventore-eos-exercitationem-et-debitis-odit-a-aut-quia",
    "thematic_areas": [
        "esse"
    ],
    "account_codes": [
        "eum"
    ],
    "organization_color": "facilis",
    "organization_logo": "aperiam",
    "noa_requisition": 16,
    "noa_requisition_names": [
        "aliquid"
    ],
    "noa_retirement": 8,
    "noa_retirement_names": [
        "hic"
    ],
    "noa_leave": 4,
    "noa_leave_names": [
        "voluptatem"
    ],
    "noa_timesheet": 9,
    "noa_timesheet_names": [
        "neque"
    ],
    "financial_year_start_month": 1,
    "financial_year_end_month": 20,
    "payment_voucher_number": 9,
    "month_start_day": 3,
    "month_end_day": 16,
    "hr_year_start_month": 3,
    "hr_year_end_month": 12
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/organizations/9';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'nesciunt',
            'email' => 'verla.buckridge@example.com',
            'phone_number' => 'deserunt',
            'registration_number' => 'debitis',
            'country' => 'et',
            'state' => 'architecto',
            'city' => 'aspernatur',
            'postcode' => 'nulla',
            'address' => 'possimus',
            'website' => 'http://shields.com/inventore-eos-exercitationem-et-debitis-odit-a-aut-quia',
            'thematic_areas' => [
                'esse',
            ],
            'account_codes' => [
                'eum',
            ],
            'organization_color' => 'facilis',
            'organization_logo' => 'aperiam',
            'noa_requisition' => 16,
            'noa_requisition_names' => [
                'aliquid',
            ],
            'noa_retirement' => 8,
            'noa_retirement_names' => [
                'hic',
            ],
            'noa_leave' => 4,
            'noa_leave_names' => [
                'voluptatem',
            ],
            'noa_timesheet' => 9,
            'noa_timesheet_names' => [
                'neque',
            ],
            'financial_year_start_month' => 1,
            'financial_year_end_month' => 20,
            'payment_voucher_number' => 9,
            'month_start_day' => 3,
            'month_end_day' => 16,
            'hr_year_start_month' => 3,
            'hr_year_end_month' => 12,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/organizations/9'
payload = {
    "name": "nesciunt",
    "email": "verla.buckridge@example.com",
    "phone_number": "deserunt",
    "registration_number": "debitis",
    "country": "et",
    "state": "architecto",
    "city": "aspernatur",
    "postcode": "nulla",
    "address": "possimus",
    "website": "http:\/\/shields.com\/inventore-eos-exercitationem-et-debitis-odit-a-aut-quia",
    "thematic_areas": [
        "esse"
    ],
    "account_codes": [
        "eum"
    ],
    "organization_color": "facilis",
    "organization_logo": "aperiam",
    "noa_requisition": 16,
    "noa_requisition_names": [
        "aliquid"
    ],
    "noa_retirement": 8,
    "noa_retirement_names": [
        "hic"
    ],
    "noa_leave": 4,
    "noa_leave_names": [
        "voluptatem"
    ],
    "noa_timesheet": 9,
    "noa_timesheet_names": [
        "neque"
    ],
    "financial_year_start_month": 1,
    "financial_year_end_month": 20,
    "payment_voucher_number": 9,
    "month_start_day": 3,
    "month_end_day": 16,
    "hr_year_start_month": 3,
    "hr_year_end_month": 12
}
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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                    "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
            "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                "updated_at": "2024-03-03T20: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-03T20:46:10.000000Z",
                    "updated_at": "2024-03-03T20: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: 9

Body Parameters

name   string  optional  

Example: nesciunt

email   string  optional  

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

phone_number   string  optional  

Example: deserunt

registration_number   string  optional  

Example: debitis

country   string  optional  

Example: et

state   string  optional  

Example: architecto

city   string  optional  

Example: aspernatur

postcode   string  optional  

Example: nulla

address   string  optional  

Example: possimus

website   string  optional  

Must be a valid URL. Example: http://shields.com/inventore-eos-exercitationem-et-debitis-odit-a-aut-quia

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

Example: 12

code   string  optional  

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

description   string  optional  

This field is required when account_codes is present. Example: Recusandae nesciunt in sit ut architecto et sed.

organization_color   string  optional  

Example: facilis

organization_logo   string  optional  

Example: aperiam

noa_requisition   integer  optional  

Example: 16

noa_requisition_names   string[]  optional  
noa_retirement   integer  optional  

Example: 8

noa_retirement_names   string[]  optional  
noa_leave   integer  optional  

Example: 4

noa_leave_names   string[]  optional  
noa_timesheet   integer  optional  

Example: 9

noa_timesheet_names   string[]  optional  
financial_year_start_month   integer  optional  

Example: 1

financial_year_end_month   integer  optional  

Example: 20

payment_voucher_number   integer  optional  

Example: 9

month_start_day   integer  optional  

Example: 3

month_end_day   integer  optional  

Example: 16

hr_year_start_month   integer  optional  

Example: 3

hr_year_end_month   integer  optional  

Example: 12

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/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/organizations/15"
);

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/15';
$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/15'
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: 15

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\": 18
}"
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": 18
};

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' => 18,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/organization_details'
payload = {
    "organization_id": 18
}
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   

Example: 18

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\": 12,
    \"name\": \"vitae\",
    \"email\": \"ferry.sage@example.org\",
    \"phone_number\": \"cum\",
    \"registration_number\": \"quas\",
    \"country\": \"sint\",
    \"state\": \"saepe\",
    \"city\": \"dolore\",
    \"postcode\": \"sunt\",
    \"address\": \"saepe\",
    \"website\": \"http:\\/\\/labadie.com\\/sed-quia-facere-rerum-qui-reiciendis-non\",
    \"thematic_areas\": [
        \"non\"
    ],
    \"account_codes\": [
        \"et\"
    ],
    \"organization_color\": \"totam\",
    \"organization_logo\": \"illum\",
    \"noa_requisition\": 4,
    \"noa_requisition_names\": [
        \"iusto\"
    ],
    \"noa_retirement\": 3,
    \"noa_retirement_names\": [
        \"nesciunt\"
    ],
    \"noa_leave\": 20,
    \"noa_leave_names\": [
        \"cumque\"
    ],
    \"noa_timesheet\": 10,
    \"noa_timesheet_names\": [
        \"aut\"
    ],
    \"financial_year_start_month\": 3,
    \"financial_year_end_month\": 13,
    \"payment_voucher_number\": 20,
    \"month_start_day\": 13,
    \"month_end_day\": 1,
    \"hr_year_start_month\": 7,
    \"hr_year_end_month\": 13
}"
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": 12,
    "name": "vitae",
    "email": "ferry.sage@example.org",
    "phone_number": "cum",
    "registration_number": "quas",
    "country": "sint",
    "state": "saepe",
    "city": "dolore",
    "postcode": "sunt",
    "address": "saepe",
    "website": "http:\/\/labadie.com\/sed-quia-facere-rerum-qui-reiciendis-non",
    "thematic_areas": [
        "non"
    ],
    "account_codes": [
        "et"
    ],
    "organization_color": "totam",
    "organization_logo": "illum",
    "noa_requisition": 4,
    "noa_requisition_names": [
        "iusto"
    ],
    "noa_retirement": 3,
    "noa_retirement_names": [
        "nesciunt"
    ],
    "noa_leave": 20,
    "noa_leave_names": [
        "cumque"
    ],
    "noa_timesheet": 10,
    "noa_timesheet_names": [
        "aut"
    ],
    "financial_year_start_month": 3,
    "financial_year_end_month": 13,
    "payment_voucher_number": 20,
    "month_start_day": 13,
    "month_end_day": 1,
    "hr_year_start_month": 7,
    "hr_year_end_month": 13
};

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' => 12,
            'name' => 'vitae',
            'email' => 'ferry.sage@example.org',
            'phone_number' => 'cum',
            'registration_number' => 'quas',
            'country' => 'sint',
            'state' => 'saepe',
            'city' => 'dolore',
            'postcode' => 'sunt',
            'address' => 'saepe',
            'website' => 'http://labadie.com/sed-quia-facere-rerum-qui-reiciendis-non',
            'thematic_areas' => [
                'non',
            ],
            'account_codes' => [
                'et',
            ],
            'organization_color' => 'totam',
            'organization_logo' => 'illum',
            'noa_requisition' => 4,
            'noa_requisition_names' => [
                'iusto',
            ],
            'noa_retirement' => 3,
            'noa_retirement_names' => [
                'nesciunt',
            ],
            'noa_leave' => 20,
            'noa_leave_names' => [
                'cumque',
            ],
            'noa_timesheet' => 10,
            'noa_timesheet_names' => [
                'aut',
            ],
            'financial_year_start_month' => 3,
            'financial_year_end_month' => 13,
            'payment_voucher_number' => 20,
            'month_start_day' => 13,
            'month_end_day' => 1,
            'hr_year_start_month' => 7,
            'hr_year_end_month' => 13,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/organization_details'
payload = {
    "organization_id": 12,
    "name": "vitae",
    "email": "ferry.sage@example.org",
    "phone_number": "cum",
    "registration_number": "quas",
    "country": "sint",
    "state": "saepe",
    "city": "dolore",
    "postcode": "sunt",
    "address": "saepe",
    "website": "http:\/\/labadie.com\/sed-quia-facere-rerum-qui-reiciendis-non",
    "thematic_areas": [
        "non"
    ],
    "account_codes": [
        "et"
    ],
    "organization_color": "totam",
    "organization_logo": "illum",
    "noa_requisition": 4,
    "noa_requisition_names": [
        "iusto"
    ],
    "noa_retirement": 3,
    "noa_retirement_names": [
        "nesciunt"
    ],
    "noa_leave": 20,
    "noa_leave_names": [
        "cumque"
    ],
    "noa_timesheet": 10,
    "noa_timesheet_names": [
        "aut"
    ],
    "financial_year_start_month": 3,
    "financial_year_end_month": 13,
    "payment_voucher_number": 20,
    "month_start_day": 13,
    "month_end_day": 1,
    "hr_year_start_month": 7,
    "hr_year_end_month": 13
}
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   

Example: 12

name   string  optional  

Example: vitae

email   string  optional  

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

phone_number   string  optional  

Example: cum

registration_number   string  optional  

Example: quas

country   string  optional  

Example: sint

state   string  optional  

Example: saepe

city   string  optional  

Example: dolore

postcode   string  optional  

Example: sunt

address   string  optional  

Example: saepe

website   string  optional  

Must be a valid URL. Example: http://labadie.com/sed-quia-facere-rerum-qui-reiciendis-non

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

Example: 16

code   string  optional  

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

description   string  optional  

This field is required when account_codes is present. Example: Sunt esse quibusdam ut rem iste ut dicta.

organization_color   string  optional  

Example: totam

organization_logo   string  optional  

Example: illum

noa_requisition   integer  optional  

Example: 4

noa_requisition_names   string[]  optional  
noa_retirement   integer  optional  

Example: 3

noa_retirement_names   string[]  optional  
noa_leave   integer  optional  

Example: 20

noa_leave_names   string[]  optional  
noa_timesheet   integer  optional  

Example: 10

noa_timesheet_names   string[]  optional  
financial_year_start_month   integer  optional  

Example: 3

financial_year_end_month   integer  optional  

Example: 13

payment_voucher_number   integer  optional  

Example: 20

month_start_day   integer  optional  

Example: 13

month_end_day   integer  optional  

Example: 1

hr_year_start_month   integer  optional  

Example: 7

hr_year_end_month   integer  optional  

Example: 13

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\": \"leave\",
    \"per_page\": 6
}"
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": "leave",
    "per_page": 6
};

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' => 'leave',
            'per_page' => 6,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/approval_sequence'
payload = {
    "request_type": "leave",
    "per_page": 6
}
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: leave

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

Example: 6

Project Endpoints

Display a listing of Projects.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/projects?term=quasi&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/projects"
);

const params = {
    "term": "quasi",
    "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/projects';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'term' => 'quasi',
            'per_page' => '16',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/projects'
params = {
  'term': 'quasi',
  '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,
            "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-05T10:00:47.000000Z",
            "updated_at": "2024-03-13T09: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-05T10:00:47.000000Z",
            "updated_at": "2024-03-13T09: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: quasi

per_page   integer  optional  

Items per page Example: 16

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\": \"sunt\",
    \"organization_id\": 4,
    \"summary\": \"excepturi\",
    \"funder_name\": \"ut\",
    \"funder_logo\": \"aliquid\",
    \"category\": [],
    \"created_by\": 13,
    \"project_amount\": \"officia\",
    \"start_date\": \"2025-01-26T17:33:47\",
    \"end_date\": \"2025-01-26T17:33:47\",
    \"project_durations\": [
        \"dignissimos\"
    ],
    \"account_codes\": [
        \"laborum\"
    ],
    \"activities\": [
        \"aut\"
    ],
    \"users\": [
        \"libero\"
    ]
}"
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": "sunt",
    "organization_id": 4,
    "summary": "excepturi",
    "funder_name": "ut",
    "funder_logo": "aliquid",
    "category": [],
    "created_by": 13,
    "project_amount": "officia",
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2025-01-26T17:33:47",
    "project_durations": [
        "dignissimos"
    ],
    "account_codes": [
        "laborum"
    ],
    "activities": [
        "aut"
    ],
    "users": [
        "libero"
    ]
};

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' => 'sunt',
            'organization_id' => 4,
            'summary' => 'excepturi',
            'funder_name' => 'ut',
            'funder_logo' => 'aliquid',
            'category' => [],
            'created_by' => 13,
            'project_amount' => 'officia',
            'start_date' => '2025-01-26T17:33:47',
            'end_date' => '2025-01-26T17:33:47',
            'project_durations' => [
                'dignissimos',
            ],
            'account_codes' => [
                'laborum',
            ],
            'activities' => [
                'aut',
            ],
            'users' => [
                'libero',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/projects'
payload = {
    "name": "sunt",
    "organization_id": 4,
    "summary": "excepturi",
    "funder_name": "ut",
    "funder_logo": "aliquid",
    "category": [],
    "created_by": 13,
    "project_amount": "officia",
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2025-01-26T17:33:47",
    "project_durations": [
        "dignissimos"
    ],
    "account_codes": [
        "laborum"
    ],
    "activities": [
        "aut"
    ],
    "users": [
        "libero"
    ]
}
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-05T10:00:47.000000Z",
            "updated_at": "2024-03-13T09: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-05T10:00:47.000000Z",
            "updated_at": "2024-03-13T09: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: sunt

organization_id   integer   

Example: 4

summary   string   

Example: excepturi

funder_name   string   

Example: ut

funder_logo   string   

Example: aliquid

category   object   
created_by   integer   

Example: 13

project_amount   string   

Example: officia

start_date   string   

Must be a valid date. Example: 2025-01-26T17:33:47

end_date   string   

Must be a valid date. Example: 2025-01-26T17:33:47

project_durations   string[]  optional  
budget   string  optional  

Example: quisquam

start_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

end_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

account_codes   string[]  optional  
code   string  optional  

Example: culpa

description   string  optional  

Example: Aut deleniti aut expedita ullam.

activities   string[]  optional  
title   string  optional  

Example: voluptas

start_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

end_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

users   integer[]  optional  
user_id   integer  optional  

Example: 14

loe   integer  optional  

Example: 17

Display the specified Project.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/projects/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/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/projects/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/projects/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": [
        {
            "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-05T10:00:47.000000Z",
            "updated_at": "2024-03-13T09: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-05T10:00:47.000000Z",
            "updated_at": "2024-03-13T09: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: 1

Update the specified Project.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/projects/18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 1,
    \"name\": \"eum\",
    \"summary\": \"quas\",
    \"funder_name\": \"vero\",
    \"funder_logo\": \"aut\",
    \"created_by\": 18,
    \"project_amount\": \"officia\",
    \"project_durations\": [
        \"ut\"
    ],
    \"account_codes\": [
        \"numquam\"
    ],
    \"activities\": [
        \"voluptate\"
    ],
    \"users\": [
        \"consequatur\"
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/projects/18"
);

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

let body = {
    "organization_id": 1,
    "name": "eum",
    "summary": "quas",
    "funder_name": "vero",
    "funder_logo": "aut",
    "created_by": 18,
    "project_amount": "officia",
    "project_durations": [
        "ut"
    ],
    "account_codes": [
        "numquam"
    ],
    "activities": [
        "voluptate"
    ],
    "users": [
        "consequatur"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/projects/18';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'organization_id' => 1,
            'name' => 'eum',
            'summary' => 'quas',
            'funder_name' => 'vero',
            'funder_logo' => 'aut',
            'created_by' => 18,
            'project_amount' => 'officia',
            'project_durations' => [
                'ut',
            ],
            'account_codes' => [
                'numquam',
            ],
            'activities' => [
                'voluptate',
            ],
            'users' => [
                'consequatur',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/projects/18'
payload = {
    "organization_id": 1,
    "name": "eum",
    "summary": "quas",
    "funder_name": "vero",
    "funder_logo": "aut",
    "created_by": 18,
    "project_amount": "officia",
    "project_durations": [
        "ut"
    ],
    "account_codes": [
        "numquam"
    ],
    "activities": [
        "voluptate"
    ],
    "users": [
        "consequatur"
    ]
}
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-05T10:00:47.000000Z",
            "updated_at": "2024-03-13T09: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-05T10:00:47.000000Z",
            "updated_at": "2024-03-13T09: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: 18

Body Parameters

organization_id   integer  optional  

Example: 1

name   string  optional  

Example: eum

summary   string  optional  

Example: quas

funder_name   string  optional  

Example: vero

funder_logo   string  optional  

Example: aut

category   object  optional  
created_by   integer   

Example: 18

project_amount   string   

Example: officia

project_durations   integer[]  optional  
id   integer  optional  

Example: 2

budget   string  optional  

Example: occaecati

start_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

end_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

account_codes   integer[]  optional  
id   integer  optional  

Example: 16

code   string  optional  

Example: dolor

description   string  optional  

Example: Consectetur illo labore doloribus ut aut consequuntur.

activities   integer[]  optional  
id   integer  optional  

Example: 14

title   string  optional  

Example: repellendus

start_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

end_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

users   integer[]  optional  
user_id   integer  optional  

Example: 8

loe   integer  optional  

Example: 18

Remove the specified Project.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/projects/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/projects/20"
);

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/20';
$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/20'
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: 20

Display a listing of the Activities.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/activities?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/activities"
);

const params = {
    "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/activities';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '11',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/activities'
params = {
  '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": 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-05T10:00:47.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:00:47.000000Z",
            "updated_at": "2024-03-05T10: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: 11

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\": 7,
    \"organization_id\": 1,
    \"project_id\": 18,
    \"title\": \"minus\",
    \"start_date\": \"2025-01-26T17:33:47\",
    \"end_date\": \"2105-01-02\"
}"
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": 7,
    "organization_id": 1,
    "project_id": 18,
    "title": "minus",
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2105-01-02"
};

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' => 7,
            'organization_id' => 1,
            'project_id' => 18,
            'title' => 'minus',
            'start_date' => '2025-01-26T17:33:47',
            'end_date' => '2105-01-02',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/activities'
payload = {
    "created_by": 7,
    "organization_id": 1,
    "project_id": 18,
    "title": "minus",
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2105-01-02"
}
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-05T10:00:47.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:00:47.000000Z",
            "updated_at": "2024-03-05T10: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   

Example: 7

organization_id   integer  optional  

Example: 1

project_id   integer   

Example: 18

title   string   

Example: minus

start_date   string   

Must be a valid date. Example: 2025-01-26T17:33:47

end_date   string   

Must be a valid date. Must be a date after start_date. Example: 2105-01-02

Show the specified Activity.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/activities/saepe" \
    --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/saepe"
);

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/saepe';
$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/saepe'
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-05T10:00:47.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:00:47.000000Z",
            "updated_at": "2024-03-05T10: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: saepe

Update the specified Activity.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/activities/amet" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 11,
    \"organization_id\": 5,
    \"project_id\": 11,
    \"title\": \"nihil\",
    \"start_date\": \"2025-01-26T17:33:47\",
    \"end_date\": \"2025-01-26T17:33:47\"
}"
const url = new URL(
    "https://api.cithar.com/api/activities/amet"
);

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

let body = {
    "created_by": 11,
    "organization_id": 5,
    "project_id": 11,
    "title": "nihil",
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2025-01-26T17:33:47"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/activities/amet';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 11,
            'organization_id' => 5,
            'project_id' => 11,
            'title' => 'nihil',
            'start_date' => '2025-01-26T17:33:47',
            'end_date' => '2025-01-26T17:33:47',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/activities/amet'
payload = {
    "created_by": 11,
    "organization_id": 5,
    "project_id": 11,
    "title": "nihil",
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2025-01-26T17:33:47"
}
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-05T10:00:47.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:00:47.000000Z",
            "updated_at": "2024-03-05T10: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: amet

Body Parameters

created_by   integer  optional  

Example: 11

organization_id   integer  optional  

Example: 5

project_id   integer  optional  

Example: 11

title   string  optional  

Example: nihil

start_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

end_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/activities/aliquid" \
    --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/aliquid"
);

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/aliquid';
$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/aliquid'
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-05T10:00:47.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:00:47.000000Z",
            "updated_at": "2024-03-05T10: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: aliquid

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\": \"attach\",
    \"project_id\": 4,
    \"users\": [
        \"quia\"
    ]
}"
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": "attach",
    "project_id": 4,
    "users": [
        "quia"
    ]
};

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' => 'attach',
            'project_id' => 4,
            'users' => [
                'quia',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/attach_project_user'
payload = {
    "operation": "attach",
    "project_id": 4,
    "users": [
        "quia"
    ]
}
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: attach

Must be one of:
  • attach
  • detach
project_id   integer   

Example: 4

users   integer[]  optional  

This field is required when operation is attach.

user_id   integer  optional  

This field is required when operation is attach. Example: 4

loe   integer   

Example: 18

user_id   object  optional  

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\": \"attach\",
    \"project_id\": 19,
    \"users\": [
        \"nam\"
    ]
}"
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": "attach",
    "project_id": 19,
    "users": [
        "nam"
    ]
};

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' => 'attach',
            'project_id' => 19,
            'users' => [
                'nam',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/detach_project_user'
payload = {
    "operation": "attach",
    "project_id": 19,
    "users": [
        "nam"
    ]
}
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: attach

Must be one of:
  • attach
  • detach
project_id   integer   

Example: 19

users   integer[]  optional  

This field is required when operation is attach.

user_id   integer  optional  

This field is required when operation is attach. Example: 19

loe   integer   

Example: 7

user_id   object  optional  

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\": 15
}"
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": 15
};

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' => 15,
        ],
    ]
);
$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": 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()

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: 15

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\": 8,
    \"start_date\": \"2025-01-26T17:33:47\",
    \"end_date\": \"2025-01-26T17:33:47\"
}"
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": 8,
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2025-01-26T17:33:47"
};

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' => 8,
            'start_date' => '2025-01-26T17:33:47',
            'end_date' => '2025-01-26T17:33:47',
        ],
    ]
);
$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": 8,
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2025-01-26T17:33:47"
}
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   

Example: 8

start_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

end_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

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: 18

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\": 8,
    \"device_token\": \"odio\"
}"
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": 8,
    "device_token": "odio"
};

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' => 8,
            'device_token' => 'odio',
        ],
    ]
);
$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": 8,
    "device_token": "odio"
}
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": "fga81lfbkPWIO17jdAI85g:APA91bG-ErXKmrgu48ESxkwh2zqazOYRxGG_BtDZf3oKSvTKltvpN26p3apALayJ9XPzeYGzyOvqH63q2BzBpe8aXwzVMQZy-BqlP2nwLC8tXnyTxl3_uRjrpEj4Of21nvuWMEWs5zYO",
        "created_at": "2024-04-27T14:30:47.000000Z",
        "updated_at": "2025-01-22T11:18:01.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  

Example: 8

device_token   string  optional  

Example: odio

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": "fga81lfbkPWIO17jdAI85g:APA91bG-ErXKmrgu48ESxkwh2zqazOYRxGG_BtDZf3oKSvTKltvpN26p3apALayJ9XPzeYGzyOvqH63q2BzBpe8aXwzVMQZy-BqlP2nwLC8tXnyTxl3_uRjrpEj4Of21nvuWMEWs5zYO",
        "created_at": "2024-04-27T14:30:47.000000Z",
        "updated_at": "2025-01-22T11:18:01.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-30T08:05:39.000000Z",
            "updated_at": "2024-04-30T08: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-30T08:05:39.000000Z",
            "updated_at": "2024-04-30T08: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\": [
        8
    ],
    \"is_read\": true
}"
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": [
        8
    ],
    "is_read": true
};

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' => [
                8,
            ],
            'is_read' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/push_notification_message'
payload = {
    "id": [
        8
    ],
    "is_read": true
}
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-30T08:05:39.000000Z",
        "updated_at": "2024-04-30T08: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: 2

Body Parameters

id   integer[]  optional  
is_read   boolean  optional  

Example: true

Delete a group of Push Notification Messages.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/push_notification_message/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/push_notification_message/20"
);

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/20';
$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/20'
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: 20

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=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/tasks"
);

const params = {
    "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/tasks';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/tasks'
params = {
  '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,
            "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-05T10:21:55.000000Z",
            "updated_at": "2024-03-13T09: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-05T10:21:55.000000Z",
            "updated_at": "2024-03-13T09: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: 1

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\": 14,
    \"organization_id\": 13,
    \"project_id\": 5,
    \"activity_id\": 8,
    \"title\": \"quisquam\",
    \"description\": \"Debitis et suscipit qui illum dolores voluptate odio eius.\",
    \"assigned_to\": 9,
    \"status\": \"ab\",
    \"start_date\": \"2025-01-26T17:33:47\",
    \"end_date\": \"2025-01-26T17:33:47\"
}"
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": 14,
    "organization_id": 13,
    "project_id": 5,
    "activity_id": 8,
    "title": "quisquam",
    "description": "Debitis et suscipit qui illum dolores voluptate odio eius.",
    "assigned_to": 9,
    "status": "ab",
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2025-01-26T17:33:47"
};

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' => 14,
            'organization_id' => 13,
            'project_id' => 5,
            'activity_id' => 8,
            'title' => 'quisquam',
            'description' => 'Debitis et suscipit qui illum dolores voluptate odio eius.',
            'assigned_to' => 9,
            'status' => 'ab',
            'start_date' => '2025-01-26T17:33:47',
            'end_date' => '2025-01-26T17:33:47',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/tasks'
payload = {
    "created_by": 14,
    "organization_id": 13,
    "project_id": 5,
    "activity_id": 8,
    "title": "quisquam",
    "description": "Debitis et suscipit qui illum dolores voluptate odio eius.",
    "assigned_to": 9,
    "status": "ab",
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2025-01-26T17:33:47"
}
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-05T10:21:55.000000Z",
            "updated_at": "2024-03-13T09: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-05T10:21:55.000000Z",
            "updated_at": "2024-03-13T09: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   

Example: 14

organization_id   integer  optional  

Example: 13

project_id   integer   

Example: 5

activity_id   integer   

Example: 8

title   string   

Example: quisquam

description   string   

Example: Debitis et suscipit qui illum dolores voluptate odio eius.

assigned_to   integer   

Example: 9

status   string   

Example: ab

start_date   string   

Must be a valid date. Example: 2025-01-26T17:33:47

end_date   string   

Must be a valid date. Example: 2025-01-26T17:33:47

Show the specified Task.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/tasks/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/tasks/13"
);

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/13';
$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/13'
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-05T10:21:55.000000Z",
            "updated_at": "2024-03-13T09: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-05T10:21:55.000000Z",
            "updated_at": "2024-03-13T09: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: 13

Update the specified Task.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/tasks/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 14,
    \"organization_id\": 16,
    \"project_id\": 19,
    \"activity_id\": 11,
    \"title\": \"reprehenderit\",
    \"description\": \"Et totam nesciunt aliquam est odit.\",
    \"type\": \"single\",
    \"assigned_to\": 13,
    \"status\": \"explicabo\",
    \"start_date\": \"2025-01-26T17:33:47\",
    \"end_date\": \"2025-01-26T17:33:47\"
}"
const url = new URL(
    "https://api.cithar.com/api/tasks/17"
);

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

let body = {
    "created_by": 14,
    "organization_id": 16,
    "project_id": 19,
    "activity_id": 11,
    "title": "reprehenderit",
    "description": "Et totam nesciunt aliquam est odit.",
    "type": "single",
    "assigned_to": 13,
    "status": "explicabo",
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2025-01-26T17:33:47"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://api.cithar.com/api/tasks/17';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 14,
            'organization_id' => 16,
            'project_id' => 19,
            'activity_id' => 11,
            'title' => 'reprehenderit',
            'description' => 'Et totam nesciunt aliquam est odit.',
            'type' => 'single',
            'assigned_to' => 13,
            'status' => 'explicabo',
            'start_date' => '2025-01-26T17:33:47',
            'end_date' => '2025-01-26T17:33:47',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/tasks/17'
payload = {
    "created_by": 14,
    "organization_id": 16,
    "project_id": 19,
    "activity_id": 11,
    "title": "reprehenderit",
    "description": "Et totam nesciunt aliquam est odit.",
    "type": "single",
    "assigned_to": 13,
    "status": "explicabo",
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2025-01-26T17:33:47"
}
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-05T10:21:55.000000Z",
            "updated_at": "2024-03-13T09: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-05T10:21:55.000000Z",
            "updated_at": "2024-03-13T09: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: 17

Body Parameters

created_by   integer  optional  

Example: 14

organization_id   integer  optional  

Example: 16

project_id   integer  optional  

Example: 19

activity_id   integer  optional  

Example: 11

title   string  optional  

Example: reprehenderit

description   string  optional  

Example: Et totam nesciunt aliquam est odit.

type   string  optional  

Example: single

Must be one of:
  • single
  • multiple
assigned_to   integer  optional  

Example: 13

status   string  optional  

Example: explicabo

start_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

end_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

Remove the specified Task.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/tasks/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/tasks/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/tasks/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/tasks/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/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: 13

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=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/get_assigned_tasks"
);

const params = {
    "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/get_assigned_tasks';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'per_page' => '1',
        ],
    ]
);
$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': '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 (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: 1

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\": 19,
    \"start_date\": \"2025-01-26T17:33:47\",
    \"end_date\": \"2025-01-26T17:33:47\"
}"
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": 19,
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2025-01-26T17:33:47"
};

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' => 19,
            'start_date' => '2025-01-26T17:33:47',
            'end_date' => '2025-01-26T17:33:47',
        ],
    ]
);
$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": 19,
    "start_date": "2025-01-26T17:33:47",
    "end_date": "2025-01-26T17:33:47"
}
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   

Example: 19

start_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

end_date   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

TimeSheet Endpoints

Display a listing of TimeSheet.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/time_sheets?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/time_sheets"
);

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/time_sheets';
$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/time_sheets'
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,
            "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-05T10:54:20.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:54:20.000000Z",
            "updated_at": "2024-03-05T10: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: 16

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\": 13,
    \"organization_id\": 12,
    \"approver\": 12,
    \"approver_role\": \"voluptate\",
    \"date\": \"quas\",
    \"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": 13,
    "organization_id": 12,
    "approver": 12,
    "approver_role": "voluptate",
    "date": "quas",
    "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' => 13,
            'organization_id' => 12,
            'approver' => 12,
            'approver_role' => 'voluptate',
            'date' => 'quas',
            '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": 13,
    "organization_id": 12,
    "approver": 12,
    "approver_role": "voluptate",
    "date": "quas",
    "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-05T10:54:20.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:54:20.000000Z",
            "updated_at": "2024-03-05T10: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   

Example: 13

organization_id   integer  optional  

Example: 12

approver   integer   

Example: 12

approver_role   string   

Example: voluptate

date   string   

Example: quas

details   object   

Show the specified TimeSheet.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/time_sheets/cumque" \
    --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/cumque"
);

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/cumque';
$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/cumque'
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-05T10:54:20.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:54:20.000000Z",
            "updated_at": "2024-03-05T10: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: cumque

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/time_sheets/et" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_by\": 17,
    \"organization_id\": 9,
    \"approver\": 11,
    \"approver_role\": \"consequatur\",
    \"date\": \"nihil\"
}"
const url = new URL(
    "https://api.cithar.com/api/time_sheets/et"
);

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

let body = {
    "created_by": 17,
    "organization_id": 9,
    "approver": 11,
    "approver_role": "consequatur",
    "date": "nihil"
};

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/et';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'created_by' => 17,
            'organization_id' => 9,
            'approver' => 11,
            'approver_role' => 'consequatur',
            'date' => 'nihil',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/time_sheets/et'
payload = {
    "created_by": 17,
    "organization_id": 9,
    "approver": 11,
    "approver_role": "consequatur",
    "date": "nihil"
}
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-05T10:54:20.000000Z",
            "updated_at": "2024-03-05T10: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-05T10:54:20.000000Z",
            "updated_at": "2024-03-05T10: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: et

Body Parameters

created_by   integer  optional  

Example: 17

organization_id   integer  optional  

Example: 9

approver   integer  optional  

Example: 11

approver_role   string  optional  

Example: consequatur

date   string  optional  

Example: nihil

details   object  optional  

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.cithar.com/api/time_sheets/est" \
    --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/est"
);

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/est';
$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/est'
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: est

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\": \"qui\"
}"
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": "qui"
};

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' => 'qui',
        ],
    ]
);
$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": "qui"
}
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: qui

User Details Endpoints

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=voluptas&last_name=ut&per_page=molestiae&user_id=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/user_details"
);

const params = {
    "first_name": "in",
    "middle_name": "voluptas",
    "last_name": "ut",
    "per_page": "molestiae",
    "user_id": "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/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' => 'voluptas',
            'last_name' => 'ut',
            'per_page' => 'molestiae',
            'user_id' => '3',
        ],
    ]
);
$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': 'voluptas',
  'last_name': 'ut',
  'per_page': 'molestiae',
  'user_id': '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,
            "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-11T09: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-11T09: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: voluptas

last_name   string  optional  

Search query parameter for last name Example: ut

per_page   string  optional  

Items per page Example: molestiae

user_id   integer  optional  

to get specific user details, when user has role to view all data in the organization Example: 3

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.cithar.com/api/user_details/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/user_details/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/user_details/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/user_details/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,
            "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-11T09: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-11T09: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: 9

Update the specified User details for admin roles.

requires authentication

Example request:
curl --request PUT \
    "https://api.cithar.com/api/user_details/14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 15,
    \"title\": \"ipsa\",
    \"first_name\": \"voluptas\",
    \"middle_name\": \"quis\",
    \"last_name\": \"ut\",
    \"phone\": \"et\",
    \"personal_email\": \"nyah79@example.net\",
    \"state_of_origin\": \"distinctio\",
    \"lga\": \"pariatur\",
    \"government_id_type\": \"quae\",
    \"government_id_number\": \"debitis\",
    \"marital_status\": \"sequi\",
    \"bank_name\": \"non\",
    \"account_name\": \"unde\",
    \"account_number\": \"aliquid\",
    \"next_of_kin_full_name\": \"nemo\",
    \"next_of_kin_phone\": \"hic\",
    \"emergency_contact_name\": \"consequatur\",
    \"emergency_contact_phone\": \"dignissimos\",
    \"emergency_contact_address\": \"est\",
    \"staff_id\": \"aut\",
    \"residential_address\": \"eaque\",
    \"dob\": \"2025-01-26T17:33:47\",
    \"gender\": \"nisi\",
    \"designation\": \"sed\",
    \"signature\": \"tenetur\",
    \"otp\": \"perspiciatis\",
    \"roles\": [
        \"voluptas\"
    ]
}"
const url = new URL(
    "https://api.cithar.com/api/user_details/14"
);

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

let body = {
    "organization_id": 15,
    "title": "ipsa",
    "first_name": "voluptas",
    "middle_name": "quis",
    "last_name": "ut",
    "phone": "et",
    "personal_email": "nyah79@example.net",
    "state_of_origin": "distinctio",
    "lga": "pariatur",
    "government_id_type": "quae",
    "government_id_number": "debitis",
    "marital_status": "sequi",
    "bank_name": "non",
    "account_name": "unde",
    "account_number": "aliquid",
    "next_of_kin_full_name": "nemo",
    "next_of_kin_phone": "hic",
    "emergency_contact_name": "consequatur",
    "emergency_contact_phone": "dignissimos",
    "emergency_contact_address": "est",
    "staff_id": "aut",
    "residential_address": "eaque",
    "dob": "2025-01-26T17:33:47",
    "gender": "nisi",
    "designation": "sed",
    "signature": "tenetur",
    "otp": "perspiciatis",
    "roles": [
        "voluptas"
    ]
};

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/14';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'organization_id' => 15,
            'title' => 'ipsa',
            'first_name' => 'voluptas',
            'middle_name' => 'quis',
            'last_name' => 'ut',
            'phone' => 'et',
            'personal_email' => 'nyah79@example.net',
            'state_of_origin' => 'distinctio',
            'lga' => 'pariatur',
            'government_id_type' => 'quae',
            'government_id_number' => 'debitis',
            'marital_status' => 'sequi',
            'bank_name' => 'non',
            'account_name' => 'unde',
            'account_number' => 'aliquid',
            'next_of_kin_full_name' => 'nemo',
            'next_of_kin_phone' => 'hic',
            'emergency_contact_name' => 'consequatur',
            'emergency_contact_phone' => 'dignissimos',
            'emergency_contact_address' => 'est',
            'staff_id' => 'aut',
            'residential_address' => 'eaque',
            'dob' => '2025-01-26T17:33:47',
            'gender' => 'nisi',
            'designation' => 'sed',
            'signature' => 'tenetur',
            'otp' => 'perspiciatis',
            'roles' => [
                'voluptas',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/user_details/14'
payload = {
    "organization_id": 15,
    "title": "ipsa",
    "first_name": "voluptas",
    "middle_name": "quis",
    "last_name": "ut",
    "phone": "et",
    "personal_email": "nyah79@example.net",
    "state_of_origin": "distinctio",
    "lga": "pariatur",
    "government_id_type": "quae",
    "government_id_number": "debitis",
    "marital_status": "sequi",
    "bank_name": "non",
    "account_name": "unde",
    "account_number": "aliquid",
    "next_of_kin_full_name": "nemo",
    "next_of_kin_phone": "hic",
    "emergency_contact_name": "consequatur",
    "emergency_contact_phone": "dignissimos",
    "emergency_contact_address": "est",
    "staff_id": "aut",
    "residential_address": "eaque",
    "dob": "2025-01-26T17:33:47",
    "gender": "nisi",
    "designation": "sed",
    "signature": "tenetur",
    "otp": "perspiciatis",
    "roles": [
        "voluptas"
    ]
}
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-11T09: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-11T09: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: 14

Body Parameters

organization_id   integer  optional  

Example: 15

title   string  optional  

Example: ipsa

first_name   string  optional  

Example: voluptas

middle_name   string  optional  

Example: quis

last_name   string  optional  

Example: ut

phone   string  optional  

Example: et

personal_email   string  optional  

Must be a valid email address. Example: nyah79@example.net

state_of_origin   string  optional  

Example: distinctio

lga   string  optional  

Example: pariatur

government_id_type   string  optional  

Example: quae

government_id_number   string  optional  

Example: debitis

marital_status   string  optional  

Example: sequi

bank_name   string  optional  

Example: non

account_name   string  optional  

Example: unde

account_number   string  optional  

Example: aliquid

next_of_kin_full_name   string  optional  

Example: nemo

next_of_kin_phone   string  optional  

Example: hic

emergency_contact_name   string  optional  

Example: consequatur

emergency_contact_phone   string  optional  

Example: dignissimos

emergency_contact_address   string  optional  

Example: est

staff_id   string  optional  

Example: aut

avatar   string  optional  
residential_address   string  optional  

Example: eaque

dob   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

gender   string  optional  

Example: nisi

designation   string  optional  

Example: sed

signature   string  optional  

Example: tenetur

otp   string  optional  

Example: perspiciatis

roles   string[]  optional  

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-11T09: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-11T09: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\": \"quis\",
    \"phone\": \"veritatis\",
    \"state_of_origin\": \"consequatur\",
    \"lga\": \"eveniet\",
    \"government_id_type\": \"et\",
    \"government_id_number\": \"sit\",
    \"marital_status\": \"et\",
    \"bank_name\": \"perspiciatis\",
    \"account_name\": \"quos\",
    \"account_number\": \"quae\",
    \"next_of_kin_full_name\": \"quasi\",
    \"next_of_kin_phone\": \"culpa\",
    \"emergency_contact_name\": \"minima\",
    \"emergency_contact_phone\": \"quae\",
    \"emergency_contact_address\": \"illo\",
    \"signature\": \"consequatur\",
    \"residential_address\": \"nobis\",
    \"dob\": \"2025-01-26T17:33:47\",
    \"gender\": \"cum\",
    \"otp\": \"doloremque\"
}"
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": "quis",
    "phone": "veritatis",
    "state_of_origin": "consequatur",
    "lga": "eveniet",
    "government_id_type": "et",
    "government_id_number": "sit",
    "marital_status": "et",
    "bank_name": "perspiciatis",
    "account_name": "quos",
    "account_number": "quae",
    "next_of_kin_full_name": "quasi",
    "next_of_kin_phone": "culpa",
    "emergency_contact_name": "minima",
    "emergency_contact_phone": "quae",
    "emergency_contact_address": "illo",
    "signature": "consequatur",
    "residential_address": "nobis",
    "dob": "2025-01-26T17:33:47",
    "gender": "cum",
    "otp": "doloremque"
};

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' => 'quis',
            'phone' => 'veritatis',
            'state_of_origin' => 'consequatur',
            'lga' => 'eveniet',
            'government_id_type' => 'et',
            'government_id_number' => 'sit',
            'marital_status' => 'et',
            'bank_name' => 'perspiciatis',
            'account_name' => 'quos',
            'account_number' => 'quae',
            'next_of_kin_full_name' => 'quasi',
            'next_of_kin_phone' => 'culpa',
            'emergency_contact_name' => 'minima',
            'emergency_contact_phone' => 'quae',
            'emergency_contact_address' => 'illo',
            'signature' => 'consequatur',
            'residential_address' => 'nobis',
            'dob' => '2025-01-26T17:33:47',
            'gender' => 'cum',
            'otp' => 'doloremque',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.cithar.com/api/user'
payload = {
    "title": "quis",
    "phone": "veritatis",
    "state_of_origin": "consequatur",
    "lga": "eveniet",
    "government_id_type": "et",
    "government_id_number": "sit",
    "marital_status": "et",
    "bank_name": "perspiciatis",
    "account_name": "quos",
    "account_number": "quae",
    "next_of_kin_full_name": "quasi",
    "next_of_kin_phone": "culpa",
    "emergency_contact_name": "minima",
    "emergency_contact_phone": "quae",
    "emergency_contact_address": "illo",
    "signature": "consequatur",
    "residential_address": "nobis",
    "dob": "2025-01-26T17:33:47",
    "gender": "cum",
    "otp": "doloremque"
}
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-11T09: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-11T09: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: quis

phone   string  optional  

Example: veritatis

state_of_origin   string  optional  

Example: consequatur

lga   string  optional  

Example: eveniet

government_id_type   string  optional  

Example: et

government_id_number   string  optional  

Example: sit

marital_status   string  optional  

Example: et

bank_name   string  optional  

Example: perspiciatis

account_name   string  optional  

Example: quos

account_number   string  optional  

Example: quae

next_of_kin_full_name   string  optional  

Example: quasi

next_of_kin_phone   string  optional  

Example: culpa

emergency_contact_name   string  optional  

Example: minima

emergency_contact_phone   string  optional  

Example: quae

emergency_contact_address   string  optional  

Example: illo

signature   string  optional  

Example: consequatur

avatar   string  optional  
residential_address   string  optional  

Example: nobis

dob   string  optional  

Must be a valid date. Example: 2025-01-26T17:33:47

gender   string  optional  

Example: cum

otp   string  optional  

Example: doloremque

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