> For the complete documentation index, see [llms.txt](https://documentation.akowe.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.akowe.app/api-reference/reference/organization.md).

# Organization

Organizations represent the entities (such as schools, companies, or institutions) under which certificates and templates are managed. Each organization record contains essential details like the organization’s name, contact information, and website.

These endpoints allow you to **create, fetch, list, and delete organizations** associated with your account.

#### Authentication

All requests must include your API key in the request headers:

* `x-api-key` *(required)* – Your unique API key from the Akowe dashboard.

***

### Create Organization

**Endpoint**:

```http
POST /api/profile/organization

```

**Description**:

Creates a new organization with details such as name, email, website, and phone number.

**Sample Request**:

```bash
curl --location '{{baseurl}}/api/profile/organization' \
--header &#x27;x-api-key: <your-api-key>&#x27; \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Akowe", 
  "website": "https://akowe.app",
  "email": "organization@email.com",
  "phone":"080123456789", 
  "logo": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAe" 
}'

```

**Sample Response**:

```json
{
  "success": true,
  "message": "Organization has been created successfully",
  "data": {
    "id": "b2bf6b4e-bb07-45ab-b5d0-c43544d2d107",
    "name": "Akowe", 
    "website": "https://akowe.app",
    "email": "organization@email.com",
    "phone":"080123456789", 
    "logo": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAe"
  }
}

```

***

### Get Organization

**Endpoint**:

```http
GET /api/profile/organization/{organizationId}

```

**Description**:

Fetches details of a specific organization by its unique ID.

**Sample Request**:

```bash
curl --location '{{baseurl}}/api/profile/organization/19ac76e7-8638-487c-861f-6565351b2f10' \
--header &#x27;x-api-key: <your-api-key>&#x27;

```

**Sample Response**:

```json
{
  "success": true,
  "message": "",
  "data": {
    "id": "19ac76e7-8638-487c-861f-6565351b2f10",
    "name": "Akowe", 
    "website": "https://akowe.app",
    "email": "organization@email.com",
    "phone":"080123456789", 
    "logo": ""
  }
}

```

***

### Get Organizations

**Endpoint**:

```http
GET /api/profile/organization

```

**Description**:

Retrieves a list of all organizations linked to your account or sub-account.

**Sample Request**:

```bash
curl --location '{{baseurl}}/api/profile/organization' \
--header &#x27;x-api-key: <your-api-key>&#x27;;

```

**Sample Response**:

```json
{
  "success": true,
  "message": "",
  "data": [
    {
      "id": "ec8566dd-56bd-49d0-b4ae-04df88cd62e9",
      "name": "Akowe",
      "email": "organization@email.com",
      "logo": "https://academicrecords.s3.eu-west-2.amazonaws.com/issuance/organization1.jpeg",
      "website": "https://akowe.app",
      "phone": "080123456789"
    }
  ]
}

```

***

### Delete Organization

**Endpoint**:

```http
DELETE /api/profile/organization/{organizationId}

```

**Description**:

Deletes a specific organization by its unique ID.

**Sample Request**:

```bash
curl --location --request DELETE '{{baseurl}}/api/profile/organization/b7013631-bc7a-40ec-96e2-13b5e67c3d02' \
--header &#x27;x-api-key: <your-api-key>&#x27;

```

**Sample Response**:

```json
{
  "success": true,
  "message": "Organization deleted successfully"
}

```

## GET /profile/organization

> Get Issuing Organizations

````json
{"openapi":"3.0.0","info":{"title":"Akowe Issuance API Endpoints","version":"1.0.0"},"tags":[{"name":"Organization","description":"Organizations represent the entities (such as schools, companies, or institutions) under which certificates and templates are managed. Each organization record contains essential details like the organization’s name, contact information, and website.\n\nThese endpoints allow you to **create, fetch, list, and delete organizations** associated with your account.\n\n### Authentication\n\nAll requests must include your API key in the request headers:\n\n- `x-api-key` _(required)_ – Your unique API key from the Akowe dashboard.\n    \n\n---\n\n## Create Organization\n\n**Endpoint**:\n\n``` http\nPOST /api/profile/organization\n\n ```\n\n**Description**:\n\nCreates a new organization with details such as name, email, website, and phone number.\n\n**Sample Request**:\n\n``` bash\ncurl --location '{{baseurl}}/api/profile/organization' \\\n--header &#x27;x-api-key: <your-api-key>&#x27; \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n  \"name\": \"Akowe\", \n  \"website\": \"https://akowe.app\",\n  \"email\": \"organization@email.com\",\n  \"phone\":\"080123456789\", \n  \"logo\": \"data:image/jpeg;base64,/9j/4AAQSkZJRgABAe\" \n}'\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"Organization has been created successfully\",\n  \"data\": {\n    \"id\": \"b2bf6b4e-bb07-45ab-b5d0-c43544d2d107\",\n    \"name\": \"Akowe\", \n    \"website\": \"https://akowe.app\",\n    \"email\": \"organization@email.com\",\n    \"phone\":\"080123456789\", \n    \"logo\": \"data:image/jpeg;base64,/9j/4AAQSkZJRgABAe\"\n  }\n}\n\n ```\n\n---\n\n## Get Organization\n\n**Endpoint**:\n\n``` http\nGET /api/profile/organization/{organizationId}\n\n ```\n\n**Description**:\n\nFetches details of a specific organization by its unique ID.\n\n**Sample Request**:\n\n``` bash\ncurl --location '{{baseurl}}/api/profile/organization/19ac76e7-8638-487c-861f-6565351b2f10' \\\n--header &#x27;x-api-key: <your-api-key>&#x27;\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": {\n    \"id\": \"19ac76e7-8638-487c-861f-6565351b2f10\",\n    \"name\": \"Akowe\", \n    \"website\": \"https://akowe.app\",\n    \"email\": \"organization@email.com\",\n    \"phone\":\"080123456789\", \n    \"logo\": \"\"\n  }\n}\n\n ```\n\n---\n\n## Get Organizations\n\n**Endpoint**:\n\n``` http\nGET /api/profile/organization\n\n ```\n\n**Description**:\n\nRetrieves a list of all organizations linked to your account or sub-account.\n\n**Sample Request**:\n\n``` bash\ncurl --location '{{baseurl}}/api/profile/organization' \\\n--header &#x27;x-api-key: <your-api-key>&#x27;;\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": [\n    {\n      \"id\": \"ec8566dd-56bd-49d0-b4ae-04df88cd62e9\",\n      \"name\": \"Akowe\",\n      \"email\": \"organization@email.com\",\n      \"logo\": \"https://academicrecords.s3.eu-west-2.amazonaws.com/issuance/organization1.jpeg\",\n      \"website\": \"https://akowe.app\",\n      \"phone\": \"080123456789\"\n    }\n  ]\n}\n\n ```\n\n---\n\n## Delete Organization\n\n**Endpoint**:\n\n``` http\nDELETE /api/profile/organization/{organizationId}\n\n ```\n\n**Description**:\n\nDeletes a specific organization by its unique ID.\n\n**Sample Request**:\n\n``` bash\ncurl --location --request DELETE '{{baseurl}}/api/profile/organization/b7013631-bc7a-40ec-96e2-13b5e67c3d02' \\\n--header &#x27;x-api-key: <your-api-key>&#x27;\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"Organization deleted successfully\"\n}\n\n ```"}],"servers":[{"url":"http://{{baseurl}}"}],"paths":{"/profile/organization":{"get":{"tags":["Organization"],"summary":"Get Issuing Organizations","parameters":[{"name":"x-api-key","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
````

## POST /profile/organization

> Create Issuing Organization

````json
{"openapi":"3.0.0","info":{"title":"Akowe Issuance API Endpoints","version":"1.0.0"},"tags":[{"name":"Organization","description":"Organizations represent the entities (such as schools, companies, or institutions) under which certificates and templates are managed. Each organization record contains essential details like the organization’s name, contact information, and website.\n\nThese endpoints allow you to **create, fetch, list, and delete organizations** associated with your account.\n\n### Authentication\n\nAll requests must include your API key in the request headers:\n\n- `x-api-key` _(required)_ – Your unique API key from the Akowe dashboard.\n    \n\n---\n\n## Create Organization\n\n**Endpoint**:\n\n``` http\nPOST /api/profile/organization\n\n ```\n\n**Description**:\n\nCreates a new organization with details such as name, email, website, and phone number.\n\n**Sample Request**:\n\n``` bash\ncurl --location '{{baseurl}}/api/profile/organization' \\\n--header &#x27;x-api-key: <your-api-key>&#x27; \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n  \"name\": \"Akowe\", \n  \"website\": \"https://akowe.app\",\n  \"email\": \"organization@email.com\",\n  \"phone\":\"080123456789\", \n  \"logo\": \"data:image/jpeg;base64,/9j/4AAQSkZJRgABAe\" \n}'\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"Organization has been created successfully\",\n  \"data\": {\n    \"id\": \"b2bf6b4e-bb07-45ab-b5d0-c43544d2d107\",\n    \"name\": \"Akowe\", \n    \"website\": \"https://akowe.app\",\n    \"email\": \"organization@email.com\",\n    \"phone\":\"080123456789\", \n    \"logo\": \"data:image/jpeg;base64,/9j/4AAQSkZJRgABAe\"\n  }\n}\n\n ```\n\n---\n\n## Get Organization\n\n**Endpoint**:\n\n``` http\nGET /api/profile/organization/{organizationId}\n\n ```\n\n**Description**:\n\nFetches details of a specific organization by its unique ID.\n\n**Sample Request**:\n\n``` bash\ncurl --location '{{baseurl}}/api/profile/organization/19ac76e7-8638-487c-861f-6565351b2f10' \\\n--header &#x27;x-api-key: <your-api-key>&#x27;\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": {\n    \"id\": \"19ac76e7-8638-487c-861f-6565351b2f10\",\n    \"name\": \"Akowe\", \n    \"website\": \"https://akowe.app\",\n    \"email\": \"organization@email.com\",\n    \"phone\":\"080123456789\", \n    \"logo\": \"\"\n  }\n}\n\n ```\n\n---\n\n## Get Organizations\n\n**Endpoint**:\n\n``` http\nGET /api/profile/organization\n\n ```\n\n**Description**:\n\nRetrieves a list of all organizations linked to your account or sub-account.\n\n**Sample Request**:\n\n``` bash\ncurl --location '{{baseurl}}/api/profile/organization' \\\n--header &#x27;x-api-key: <your-api-key>&#x27;;\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": [\n    {\n      \"id\": \"ec8566dd-56bd-49d0-b4ae-04df88cd62e9\",\n      \"name\": \"Akowe\",\n      \"email\": \"organization@email.com\",\n      \"logo\": \"https://academicrecords.s3.eu-west-2.amazonaws.com/issuance/organization1.jpeg\",\n      \"website\": \"https://akowe.app\",\n      \"phone\": \"080123456789\"\n    }\n  ]\n}\n\n ```\n\n---\n\n## Delete Organization\n\n**Endpoint**:\n\n``` http\nDELETE /api/profile/organization/{organizationId}\n\n ```\n\n**Description**:\n\nDeletes a specific organization by its unique ID.\n\n**Sample Request**:\n\n``` bash\ncurl --location --request DELETE '{{baseurl}}/api/profile/organization/b7013631-bc7a-40ec-96e2-13b5e67c3d02' \\\n--header &#x27;x-api-key: <your-api-key>&#x27;\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"Organization deleted successfully\"\n}\n\n ```"}],"servers":[{"url":"http://{{baseurl}}"}],"paths":{"/profile/organization":{"post":{"tags":["Organization"],"summary":"Create Issuing Organization","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"x-api-key","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
````

## DELETE /profile/organization/b2bf6b4e-bb07-45ab-b5d0-c43544d2d107

> Delete Issuing Organization

````json
{"openapi":"3.0.0","info":{"title":"Akowe Issuance API Endpoints","version":"1.0.0"},"tags":[{"name":"Organization","description":"Organizations represent the entities (such as schools, companies, or institutions) under which certificates and templates are managed. Each organization record contains essential details like the organization’s name, contact information, and website.\n\nThese endpoints allow you to **create, fetch, list, and delete organizations** associated with your account.\n\n### Authentication\n\nAll requests must include your API key in the request headers:\n\n- `x-api-key` _(required)_ – Your unique API key from the Akowe dashboard.\n    \n\n---\n\n## Create Organization\n\n**Endpoint**:\n\n``` http\nPOST /api/profile/organization\n\n ```\n\n**Description**:\n\nCreates a new organization with details such as name, email, website, and phone number.\n\n**Sample Request**:\n\n``` bash\ncurl --location '{{baseurl}}/api/profile/organization' \\\n--header &#x27;x-api-key: <your-api-key>&#x27; \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n  \"name\": \"Akowe\", \n  \"website\": \"https://akowe.app\",\n  \"email\": \"organization@email.com\",\n  \"phone\":\"080123456789\", \n  \"logo\": \"data:image/jpeg;base64,/9j/4AAQSkZJRgABAe\" \n}'\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"Organization has been created successfully\",\n  \"data\": {\n    \"id\": \"b2bf6b4e-bb07-45ab-b5d0-c43544d2d107\",\n    \"name\": \"Akowe\", \n    \"website\": \"https://akowe.app\",\n    \"email\": \"organization@email.com\",\n    \"phone\":\"080123456789\", \n    \"logo\": \"data:image/jpeg;base64,/9j/4AAQSkZJRgABAe\"\n  }\n}\n\n ```\n\n---\n\n## Get Organization\n\n**Endpoint**:\n\n``` http\nGET /api/profile/organization/{organizationId}\n\n ```\n\n**Description**:\n\nFetches details of a specific organization by its unique ID.\n\n**Sample Request**:\n\n``` bash\ncurl --location '{{baseurl}}/api/profile/organization/19ac76e7-8638-487c-861f-6565351b2f10' \\\n--header &#x27;x-api-key: <your-api-key>&#x27;\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": {\n    \"id\": \"19ac76e7-8638-487c-861f-6565351b2f10\",\n    \"name\": \"Akowe\", \n    \"website\": \"https://akowe.app\",\n    \"email\": \"organization@email.com\",\n    \"phone\":\"080123456789\", \n    \"logo\": \"\"\n  }\n}\n\n ```\n\n---\n\n## Get Organizations\n\n**Endpoint**:\n\n``` http\nGET /api/profile/organization\n\n ```\n\n**Description**:\n\nRetrieves a list of all organizations linked to your account or sub-account.\n\n**Sample Request**:\n\n``` bash\ncurl --location '{{baseurl}}/api/profile/organization' \\\n--header &#x27;x-api-key: <your-api-key>&#x27;;\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": [\n    {\n      \"id\": \"ec8566dd-56bd-49d0-b4ae-04df88cd62e9\",\n      \"name\": \"Akowe\",\n      \"email\": \"organization@email.com\",\n      \"logo\": \"https://academicrecords.s3.eu-west-2.amazonaws.com/issuance/organization1.jpeg\",\n      \"website\": \"https://akowe.app\",\n      \"phone\": \"080123456789\"\n    }\n  ]\n}\n\n ```\n\n---\n\n## Delete Organization\n\n**Endpoint**:\n\n``` http\nDELETE /api/profile/organization/{organizationId}\n\n ```\n\n**Description**:\n\nDeletes a specific organization by its unique ID.\n\n**Sample Request**:\n\n``` bash\ncurl --location --request DELETE '{{baseurl}}/api/profile/organization/b7013631-bc7a-40ec-96e2-13b5e67c3d02' \\\n--header &#x27;x-api-key: <your-api-key>&#x27;\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"Organization deleted successfully\"\n}\n\n ```"}],"servers":[{"url":"http://{{baseurl}}"}],"paths":{"/profile/organization/b2bf6b4e-bb07-45ab-b5d0-c43544d2d107":{"delete":{"tags":["Organization"],"summary":"Delete Issuing Organization","parameters":[{"name":"x-api-key","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
````

## GET /profile/organization/19ac76e7-8638-487c-861f-6565351b2f10

> Get Issuing Organization

````json
{"openapi":"3.0.0","info":{"title":"Akowe Issuance API Endpoints","version":"1.0.0"},"tags":[{"name":"Organization","description":"Organizations represent the entities (such as schools, companies, or institutions) under which certificates and templates are managed. Each organization record contains essential details like the organization’s name, contact information, and website.\n\nThese endpoints allow you to **create, fetch, list, and delete organizations** associated with your account.\n\n### Authentication\n\nAll requests must include your API key in the request headers:\n\n- `x-api-key` _(required)_ – Your unique API key from the Akowe dashboard.\n    \n\n---\n\n## Create Organization\n\n**Endpoint**:\n\n``` http\nPOST /api/profile/organization\n\n ```\n\n**Description**:\n\nCreates a new organization with details such as name, email, website, and phone number.\n\n**Sample Request**:\n\n``` bash\ncurl --location '{{baseurl}}/api/profile/organization' \\\n--header &#x27;x-api-key: <your-api-key>&#x27; \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n  \"name\": \"Akowe\", \n  \"website\": \"https://akowe.app\",\n  \"email\": \"organization@email.com\",\n  \"phone\":\"080123456789\", \n  \"logo\": \"data:image/jpeg;base64,/9j/4AAQSkZJRgABAe\" \n}'\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"Organization has been created successfully\",\n  \"data\": {\n    \"id\": \"b2bf6b4e-bb07-45ab-b5d0-c43544d2d107\",\n    \"name\": \"Akowe\", \n    \"website\": \"https://akowe.app\",\n    \"email\": \"organization@email.com\",\n    \"phone\":\"080123456789\", \n    \"logo\": \"data:image/jpeg;base64,/9j/4AAQSkZJRgABAe\"\n  }\n}\n\n ```\n\n---\n\n## Get Organization\n\n**Endpoint**:\n\n``` http\nGET /api/profile/organization/{organizationId}\n\n ```\n\n**Description**:\n\nFetches details of a specific organization by its unique ID.\n\n**Sample Request**:\n\n``` bash\ncurl --location '{{baseurl}}/api/profile/organization/19ac76e7-8638-487c-861f-6565351b2f10' \\\n--header &#x27;x-api-key: <your-api-key>&#x27;\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": {\n    \"id\": \"19ac76e7-8638-487c-861f-6565351b2f10\",\n    \"name\": \"Akowe\", \n    \"website\": \"https://akowe.app\",\n    \"email\": \"organization@email.com\",\n    \"phone\":\"080123456789\", \n    \"logo\": \"\"\n  }\n}\n\n ```\n\n---\n\n## Get Organizations\n\n**Endpoint**:\n\n``` http\nGET /api/profile/organization\n\n ```\n\n**Description**:\n\nRetrieves a list of all organizations linked to your account or sub-account.\n\n**Sample Request**:\n\n``` bash\ncurl --location '{{baseurl}}/api/profile/organization' \\\n--header &#x27;x-api-key: <your-api-key>&#x27;;\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": [\n    {\n      \"id\": \"ec8566dd-56bd-49d0-b4ae-04df88cd62e9\",\n      \"name\": \"Akowe\",\n      \"email\": \"organization@email.com\",\n      \"logo\": \"https://academicrecords.s3.eu-west-2.amazonaws.com/issuance/organization1.jpeg\",\n      \"website\": \"https://akowe.app\",\n      \"phone\": \"080123456789\"\n    }\n  ]\n}\n\n ```\n\n---\n\n## Delete Organization\n\n**Endpoint**:\n\n``` http\nDELETE /api/profile/organization/{organizationId}\n\n ```\n\n**Description**:\n\nDeletes a specific organization by its unique ID.\n\n**Sample Request**:\n\n``` bash\ncurl --location --request DELETE '{{baseurl}}/api/profile/organization/b7013631-bc7a-40ec-96e2-13b5e67c3d02' \\\n--header &#x27;x-api-key: <your-api-key>&#x27;\n\n ```\n\n**Sample Response**:\n\n``` json\n{\n  \"success\": true,\n  \"message\": \"Organization deleted successfully\"\n}\n\n ```"}],"servers":[{"url":"http://{{baseurl}}"}],"paths":{"/profile/organization/19ac76e7-8638-487c-861f-6565351b2f10":{"get":{"tags":["Organization"],"summary":"Get Issuing Organization","parameters":[{"name":"x-api-key","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
````


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.akowe.app/api-reference/reference/organization.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.