Skip to main content
GET
/
api
/
canary
/
authentication
/
organization
/
list
List Organizations
curl --request GET \
  --url https://api.cashful.africa/api/canary/authentication/organization/list \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "org_12345",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "createdAt": "2024-01-01T00:00:00Z",
    "logo": "https://www.cashful.africa/logo.png",
    "metadata": {
      "plan": "pro"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
include
boolean

Include additional organization data

Example:

true

Response

Organizations listed successfully

​
id
string
required

Organization ID

Example:

"org_12345"

​
name
string
required

Organization name

Example:

"Acme Corp"

​
slug
string
required

Organization slug

Example:

"acme-corp"

​
createdAt
string
required

Organization creation date

Example:

"2024-01-01T00:00:00Z"

Organization logo

Example:

"https://www.cashful.africa/logo.png"

​
metadata
object

Organization metadata

Example:
{ "plan": "pro" }