Organizations

Organizations represent a single tenant of Omnifuel application.

The organization model

The message model contains all the information about the organization.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the organization.

  • Name
    name
    Type
    string
    Description

    The name of the organization.

  • Name
    slug
    Type
    string
    Description

    The slug of the organization.


GET/v1/organizations

List all organizations

This endpoint allows you to retrieve a paginated list of all your messages (in a conversation if a conversation id is provided). By default, a maximum of ten messages are shown per page.

Request

GET
/v1/organizations
curl -G https://api.omnifuel.io/v1/organizations \
  -H "Authorization: Bearer {token}" \

Response

{
  "data": [
    {
        "id": "f23402fd-69de-47e1-a83e-873a448fae83",
        "name": "Organization Name",
        "slug": "organization_x"
    }
  ]
}

Was this page helpful?